Repository navigation
Fill gaps from assistant conversations: checkMatch arrays and env add - #466
Merged
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
hlenke
reviewed
Nov 3, 2026
hlenke
left a comment
Member
There was a problem hiding this comment.
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-checksfails, but not because of this PR. Its log (run 41096453730) showscheck-api-preview.mjsgetting 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, andpreview-checkspasses on later PRs (for example #775), so re-run the check or mergemainagain. - Mergeable: yes.
mainchangedconstructs/project.mdxsince 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.pyreports nothing. The#checkly-env-updateanchor matches thecheckly env updateheading on the same page. - Description vs. diff: the PR description says it corrects the
checkMatchtype "fromstringtostring | string[]", butmainalready hadstring | 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
3db03cb1for all three files, andcli/checkly-env.mdxin full at the PR head. gh pr checks 466: onlypreview-checksfails. I read its failed log (see above).checkMatchtype: checkly-cliorigin/main@4e450744,packages/cli/src/services/checkly-config-loader.ts:73declarescheckMatch?: string | string[].- End-to-end,
checkMatcharray: a project withcheckMatch: ['**/*.check.ts', '**/*.check.js']and one URL monitor in a.check.tsfile and one in a.check.jsfile.checkly testagainst 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,
envsubcommands against the same local app, with a throwaway variable that I removed afterwards:env addon a new key: added.env addon the same key again: exit 1, "already exists".env update(plain): updated.env update ... --secreton that plain variable: "Secret environment variable ... updated", and the API then returnedsecret: true.env updatewithout--secretafterwards: exit 1, "cannot be changed to secret: false", which matches the existing Warning on the page.env rm --force: deleted.
checkly-clipackages/cli/src/commands/env/add.tsandupdate.ts: both accept--secret, andupdatesends it to the API.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Close two documentation gaps surfaced by recurring assistant conversations: how to match multiple file globs with
checkMatch, and what to do whencheckly env addtargets a key that already exists.Changes
constructs/project.mdx: correctchecks.checkMatchtype fromstringtostring | string[]in both the properties table and the ResponseField, and add an inline example showing an array of globs.constructs/including-checks.mdx: note thatcheckMatchalso accepts an array of glob patterns, with an example matching multiple file extensions.cli/checkly-env.mdx: add a note undercheckly env addclarifying that it is for creating new variables only, pointing users tocheckly env updatefor existing keys and tocheckly env rm+add --secretfor converting a plain variable to a secret.Context
Assistant sessions repeatedly asked how to include multiple check file extensions and what happens when
env addis called for an existing key; the existing pages were ambiguous or silent on both points.