Clarify multi-environment monitoring guidance - #454
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
thebiglabasky
marked this pull request as ready for review
July 27, 2026 17:09
thebiglabasky
commented
Jul 27, 2026
| | Test an ephemeral preview deployment | Run `checkly test` with temporary environment variables. Do not deploy it as a scheduled monitor. | | ||
| | Continuously monitor the same checks in development, staging, and production | Deploy the same check code as a separate CLI project for each environment. Give every project a unique, stable `logicalId`. | | ||
| | Continuously monitor different checks in each environment | Use a separate project for each environment and select shared and environment-specific check files in the project configuration. | | ||
| | Test lower environments but monitor only production | Run `checkly test` against lower environments, then deploy only the production project. | |
Contributor
Author
There was a problem hiding this comment.
That looks a bit odd. Not sure what a "lower" environment is and what's the use case. I'd strike that out
| CHECKLY_ENVIRONMENT=staging \ | ||
| ENVIRONMENT_URL="https://staging-api.example.com" \ | ||
| API_TOKEN="$STAGING_API_TOKEN" \ | ||
| npx checkly deploy --force |
Contributor
Author
There was a problem hiding this comment.
I wouldn't default examples to --force
thebiglabasky
enabled auto-merge (squash)
July 27, 2026 17:11
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
1 participant
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
checkly test --envand--env-filevalues do not update scheduled monitorsWhy
The existing guide made environments sound like a first-class Checkly resource, but did not explain how projects, variables, and CI/CD deployments fit together. Its examples also omitted required project identities and demonstrated testing staging while deploying only production, leaving the continuous multi-environment workflow unclear.
This documents the workflow that is supported today without implying additional product functionality.
Related context: ENG-102
Validation
checkly validatefor the shared multi-environment configuration and checkcheckly validatefor environment-specificcheckMatchnpx mint broken-links