From 97da09cdf0112866f767c4a6f55985fd4c64a561 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 31 Jul 2026 13:08:57 +0000 Subject: [PATCH 1/5] docs: clarify checkMatch array support and env add for existing keys --- cli/checkly-env.mdx | 2 ++ constructs/including-checks.mdx | 4 ++-- constructs/project.mdx | 11 +++++++---- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/cli/checkly-env.mdx b/cli/checkly-env.mdx index 7dcd25994..926f561e9 100644 --- a/cli/checkly-env.mdx +++ b/cli/checkly-env.mdx @@ -39,6 +39,8 @@ Create a new global environment variable. npx checkly env add [options] ``` +Use `checkly env add` only to create new variables. If a variable with the same key already exists, use [`checkly env update`](#checkly-env-update) to change its value. To convert an existing plain variable into a secret, first remove it with `checkly env rm ` and then re-add it with `--secret`. + **Options:** | Option | Required | Description | diff --git a/constructs/including-checks.mdx b/constructs/including-checks.mdx index 3acfd16c4..d8cba1821 100644 --- a/constructs/including-checks.mdx +++ b/constructs/including-checks.mdx @@ -10,8 +10,8 @@ create checks and monitors. This approach enables you to add and remove files fr ## `checks.checkMatch` -The `checkMatch` property takes a [glob pattern](https://www.npmjs.com/package/glob) to match files inside your -project structure that contain instances of a Check, i.e. `**/__checks__/*.check.ts`. +The `checkMatch` property takes a [glob pattern](https://www.npmjs.com/package/glob) — or an array of glob patterns — to match files inside your +project structure that contain instances of a Check, i.e. `**/__checks__/*.check.ts`. Use an array when you need to match multiple file extensions or directories, e.g. `["**/*.check.ts", "**/*.check.js"]`. The goal of this property is so you can add files to an existing repo that are automatically detected. This pattern should be very familiar to unit testing: the test runner takes care of finding, building and running all the files. diff --git a/constructs/project.mdx b/constructs/project.mdx index 6a62faf1c..b334c34e6 100644 --- a/constructs/project.mdx +++ b/constructs/project.mdx @@ -187,7 +187,7 @@ export default defineConfig({ |-----------|------|----------|---------|-------------| | `activated` | `boolean` | ❌ | `true` | Whether checks are enabled by default | | `alertChannels` | `Array` | ❌ | `[]` | Default alert channels for all checks | -| `checkMatch` | `string` | ❌ | - | Glob pattern to find check construct files | +| `checkMatch` | `string` \| `string[]` | ❌ | - | Glob pattern (or array of glob patterns) to find check construct files | | `environmentVariables` | `EnvironmentVariable[]` | ❌ | `[]` | Default environment variables for all checks | | `frequency` | `Frequency` | ❌ | - | Default frequency for all checks | | `ignoreDirectoriesMatch` | `string[]` | - | - | Glob patterns for directories to ignore | @@ -250,9 +250,9 @@ export default defineConfig({ - + -Glob pattern where the CLI looks for files containing Check constructs, i.e. all `.check.ts` files. +Glob pattern (or array of glob patterns) where the CLI looks for files containing Check constructs, i.e. all `.check.ts` files. Pass an array to match multiple file extensions or directories at once. **Usage:** @@ -261,7 +261,10 @@ export default defineConfig({ projectName: "Website Monitoring", logicalId: "website-monitoring-1", checks: { - checkMatch: ["**/*.check.ts"], + // Match a single glob + checkMatch: "**/*.check.ts", + // Or match multiple globs at once + // checkMatch: ["**/*.check.ts", "**/*.check.js"], }, }) ``` From 0fa0c4a0b817a65cd69a0f02454bf8aba3ef3641 Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Tue, 3 Nov 2026 20:39:46 -0500 Subject: [PATCH 2/5] Update cli/checkly-env.mdx --- cli/checkly-env.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/checkly-env.mdx b/cli/checkly-env.mdx index 607a4f3c5..6e4b429f4 100644 --- a/cli/checkly-env.mdx +++ b/cli/checkly-env.mdx @@ -41,7 +41,7 @@ npx checkly env add [value] [options] If you leave out the value, the CLI asks for it with a hidden input, which keeps it out of your shell history. -Use `checkly env add` only to create new variables. If a variable with the same key already exists, use [`checkly env update`](#checkly-env-update) to change its value. To convert an existing plain variable into a secret, first remove it with `checkly env rm ` and then re-add it with `--secret`. +`checkly env add` fails if a variable with the same key already exists. Use [`checkly env update`](#checkly-env-update) to change its value, or pass `--secret` to `env update` to turn a plain variable into a secret. **Options:** From 2e3bafed0b59176abd9b6d5d36d5ec4992451438 Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Tue, 3 Nov 2026 20:41:35 -0500 Subject: [PATCH 3/5] Update constructs/project.mdx --- constructs/project.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/constructs/project.mdx b/constructs/project.mdx index b753d6579..2d918477d 100644 --- a/constructs/project.mdx +++ b/constructs/project.mdx @@ -263,7 +263,7 @@ export default defineConfig({ -Glob pattern (or array of glob patterns) where the CLI looks for files containing Check constructs, i.e. all `.check.ts` files. Pass an array to match multiple file extensions or directories at once. +A glob pattern, or an array of glob patterns, where the CLI looks for files containing check constructs, for example all `.check.ts` files. Use an array to match several file extensions or directories. **Usage:** From bff291bb0c3c6a858a4a335ea4b7c206b4e6644f Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Tue, 3 Nov 2026 20:42:15 -0500 Subject: [PATCH 4/5] Update constructs/project.mdx --- constructs/project.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/constructs/project.mdx b/constructs/project.mdx index 2d918477d..522cc5d26 100644 --- a/constructs/project.mdx +++ b/constructs/project.mdx @@ -195,7 +195,7 @@ export default defineConfig({ |-----------|------|----------|---------|-------------| | `activated` | `boolean` | ❌ | `true` | Whether checks are enabled by default | | `alertChannels` | `Array` | ❌ | `[]` | Default alert channels for all checks | -| `checkMatch` | `string \| string[]` | ❌ | - | Glob pattern (or array of glob patterns) to find check construct files | +| `checkMatch` | `string \| string[]` | ❌ | - | Glob pattern or array of glob patterns to find check construct files | | `environmentVariables` | `EnvironmentVariable[]` | ❌ | `[]` | Default environment variables for all checks | | `frequency` | `Frequency` | ❌ | - | Default frequency for all checks | | `ignoreDirectoriesMatch` | `string[]` | - | - | Glob patterns for directories to ignore | From e7634188922ef650dcafe660835002da81b6c8cf Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Tue, 3 Nov 2026 20:42:37 -0500 Subject: [PATCH 5/5] Update constructs/including-checks.mdx --- constructs/including-checks.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/constructs/including-checks.mdx b/constructs/including-checks.mdx index d8ee6acbf..ea115b28b 100644 --- a/constructs/including-checks.mdx +++ b/constructs/including-checks.mdx @@ -10,8 +10,8 @@ create checks and monitors. This approach enables you to add and remove files fr ## `checks.checkMatch` -The `checkMatch` property takes a [glob pattern](https://www.npmjs.com/package/glob) — or an array of glob patterns — to match files inside your -project structure that contain instances of a Check, i.e. `**/__checks__/*.check.ts`. Use an array when you need to match multiple file extensions or directories, e.g. `["**/*.check.ts", "**/*.check.js"]`. +The `checkMatch` property takes a [glob pattern](https://www.npmjs.com/package/glob), or an array of glob patterns, to match files inside your +project structure that contain check constructs, for example `**/__checks__/*.check.ts`. Use an array to match several file extensions or directories, for example `["**/*.check.ts", "**/*.check.js"]`. The goal of this property is so you can add files to an existing repo that are automatically detected. This pattern should be very familiar to unit testing: the test runner takes care of finding, building and running all the files.