Repository navigation
Conversation
…the app [RED-1289] Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
hlenke
reviewed
Nov 3, 2026
hlenke
left a comment
Member
There was a problem hiding this comment.
Needs changes · The sentence matches checkly/checkly-cli#1585, but that PR is still open and the behavior is in no released CLI, so hold this until #1585 ships and then add the CLI version it shipped in.
Merge readiness
- Blocker: the behavior is not released yet. checkly/checkly-cli#1585 is open and unmerged, and
SlackAppAlertChannelon checkly-climain(4e450744,packages/cli/src/constructs/slack-app-alert-channel.ts) has novalidate()override, so no CLI version fails this way today. The PR description already says to merge this last. Until then the page describes behavior readers cannot reproduce. Once a CLI release contains #1585 and the backend change it depends on is deployed, put that CLI version into the note suggested inline. - CI: all checks pass. Mergeable: clean, and no other open PR touches this file.
- Siblings: no other alert-channel construct page needs the same note. Only the Slack App channel depends on an installed integration.
Inline comments
1 wording comment.
What I checked
- Read the diff from merge base
e33fe081and the whole page at the PR head. gh pr checks 738: all six pass.gh pr view 738:MERGEABLE/CLEAN.mainchanged this file since the base only in #734 and the snippet typecheck commit, and neither touches this line.- checkly/checkly-cli#1585 (open): its construct change adds a
validate()that reports an error diagnostic when the account reports the Slack integration as not connected andslackChannelsis non-empty. The check is skipped when the API does not report the integration. The error hint links to the account's Integrations settings. The PR description saysvalidate,test,deploy,pw-test, andimport planall run this validation. - checkly-cli
origin/main@4e450744:slack-app-alert-channel.tshas no validation of this kind. - End-to-end: not run. The latest CLI (10.1.0) does not contain #1585, so a local run would only show today's behavior (no error).
- Convention check (
references/repo-knowledge.md): Tip is for cross-links and Note for plan or version gating, so the version-dependent sentence belongs in a Note.
Comment on lines
11
to
13
| <Tip> | ||
| Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. | ||
| Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. When it isn't connected to your Checkly account, the CLI commands that validate your project, such as `npx checkly validate`, `test` and `deploy`, fail with an error for each Slack App alert channel with Slack destinations. | ||
| </Tip> |
Member
There was a problem hiding this comment.
Wording: Three changes:
- "With Slack destinations" is hard to read. In #1585 the check fires only when
slackChannelsis non-empty, so name the prop. - Version-gated behavior goes in a
<Note>. The<Tip>stays the cross-link. - Tell the reader how to fix it, as the CLI hint does.
Replace X.Y.Z with the CLI release that ships checkly/checkly-cli#1585.
Suggested change
| <Tip> | |
| Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. | |
| Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. When it isn't connected to your Checkly account, the CLI commands that validate your project, such as `npx checkly validate`, `test` and `deploy`, fail with an error for each Slack App alert channel with Slack destinations. | |
| </Tip> | |
| <Tip> | |
| Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. | |
| </Tip> | |
| <Note> | |
| Since CLI vX.Y.Z, `npx checkly validate`, `test`, and `deploy` fail with an error for each `SlackAppAlertChannel` with a non-empty `slackChannels` list when the Checkly Slack App is not connected to your Checkly account. Connect it under [Account settings > Integrations](https://app.checklyhq.com/settings/account/integrations), or remove the channel. | |
| </Note> |
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.
Affected Components
The SlackAppAlertChannel construct page's tip now says that the CLI commands that validate a project, such as
validate,testanddeploy, fail for a Slack App alert channel with Slack destinations when the Checkly Slack App isn't connected to the account.Notes for the Reviewer
Merge this last: it describes behaviour from checkly/checkly-cli#1585, which depends on a backend change (RED-1289) and only applies once both are released.
🤖 Generated with Claude Code