Skip to content

Fill gaps from assistant conversations: checkMatch arrays and env add - #466

Merged
hlenke merged 6 commits into
mainfrom
mintlify/98a58ea2
Nov 4, 2026
Merged

hlenke merged 6 commits into
mainfrom
mintlify/98a58ea2

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Close two documentation gaps surfaced by recurring assistant conversations: how to match multiple file globs with checkMatch, and what to do when checkly env add targets a key that already exists.

Changes

  • constructs/project.mdx: correct checks.checkMatch type from string to string | string[] in both the properties table and the ResponseField, and add an inline example showing an array of globs.
  • constructs/including-checks.mdx: note that checkMatch also accepts an array of glob patterns, with an example matching multiple file extensions.
  • cli/checkly-env.mdx: add a note under checkly env add clarifying that it is for creating new variables only, pointing users to checkly env update for existing keys and to checkly env rm + add --secret for converting a plain variable to a secret.

Context

Assistant sessions repeatedly asked how to include multiple check file extensions and what happens when env add is called for an existing key; the existing pages were ambiguous or silent on both points.

@mintlify

mintlify Bot commented Jul 31, 2026 •

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 4, 2026, 1:43 AM

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs changes · The checkMatch array additions are correct, but the new env add note tells readers to delete and re-create a variable to make it a secret, and checkly env update --secret does that directly. Fix that note first.

Merge readiness

  • CI: preview-checks fails, but not because of this PR. Its log (run 41096453730) shows check-api-preview.mjs getting HTTP 404 for every status page, status page incident, and status page service API reference URL on this PR's Mintlify preview. This PR touches no API reference page, and preview-checks passes on later PRs (for example #775), so re-run the check or merge main again.
  • Mergeable: yes. main changed constructs/project.mdx since the merge base only in #782 (wide mode) and #734 (casing), and neither touches these hunks.
  • Overlap: no other open non-draft PR touches these three files.
  • Cross-file impact: pr_impact.py reports nothing. The #checkly-env-update anchor matches the checkly env update heading on the same page.
  • Description vs. diff: the PR description says it corrects the checkMatch type "from string to string | string[]", but main already had string | string[] in both places. The real change is the prose and the example.

Inline comments

1 blocker, 1 important, 3 wording.

What I checked
  • Read the diff from merge base 3db03cb1 for all three files, and cli/checkly-env.mdx in full at the PR head.
  • gh pr checks 466: only preview-checks fails. I read its failed log (see above).
  • checkMatch type: checkly-cli origin/main@4e450744, packages/cli/src/services/checkly-config-loader.ts:73 declares checkMatch?: string | string[].
  • End-to-end, checkMatch array: a project with checkMatch: ['**/*.check.ts', '**/*.check.js'] and one URL monitor in a .check.ts file and one in a .check.js file. checkly test against local Checkly (monorepo 23a0c61682, CLI 10.1.0) parsed, bundled, and listed both monitors ("Running 2 checks"), so both globs matched. The checks themselves stayed in scheduling on the local app; I stopped the run there, since matching was the claim under test.
  • End-to-end, env subcommands against the same local app, with a throwaway variable that I removed afterwards:
    • env add on a new key: added.
    • env add on the same key again: exit 1, "already exists".
    • env update (plain): updated.
    • env update ... --secret on that plain variable: "Secret environment variable ... updated", and the API then returned secret: true.
    • env update without --secret afterwards: exit 1, "cannot be changed to secret: false", which matches the existing Warning on the page.
    • env rm --force: deleted.
  • checkly-cli packages/cli/src/commands/env/add.ts and update.ts: both accept --secret, and update sends it to the API.

Comment thread cli/checkly-env.mdx Resolved
Comment thread constructs/project.mdx Resolved
Comment thread constructs/project.mdx Resolved
Comment thread constructs/including-checks.mdx Resolved
@hlenke
hlenke merged commit 812d136 into main Nov 4, 2026
6 checks passed
@hlenke
hlenke deleted the mintlify/98a58ea2 branch November 4, 2026 01:48

This branch was successfully deployed

1 active deployment
staging — e7634188 Deployed Nov 4, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant