Skip to content

Document Checkly GitHub Action workflows#445

Open
thebiglabasky wants to merge 7 commits into
mainfrom
herve/checkly-action-docs
Open

Document Checkly GitHub Action workflows#445
thebiglabasky wants to merge 7 commits into
mainfrom
herve/checkly-action-docs

Conversation

@thebiglabasky

@thebiglabasky thebiglabasky commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document the published Checkly Action v1 workflow for repository constructs and deployed checks
  • Explain auto, github-check, and github-actions without conflating workflow jobs, external Check Runs, legacy commit statuses, Checkly checks, or test-session results
  • Cover local CLI resolution, monorepo dependency setup, explicit GitHub SHA selection, preview targets, and advanced merge protection
  • Keep GitHub deployment hooks as a separate supported integration and remove its stale screenshots

Published versions checked

  • Checkly Action release: v1.1.0; checkly/checkly-action@v1 resolves to the v1.1.0 commit
  • Checkly CLI latest: 8.17.1
  • Minimum compatible Checkly CLI: 8.15.0
  • The GitHub Marketplace page currently still renders v1.0.0 content even though GitHub's latest release API reports v1.1.0

Validation

  • Parsed all 8 YAML examples
  • Checkly Action v1.1.0: ./scripts/test.sh
  • Checkly Action v1.1.0: ./scripts/test-integration.sh
  • python3 .github/scripts/check_frontmatter.py
  • python3 .github/scripts/check_redirect_destinations.py
  • Regenerated sitemap.xml and confirmed no diff
  • npx --yes mint@4.2.259 broken-links
  • git diff --check
  • mint validate reaches the full build and reports only the two existing shared-snippet React import warnings in snippets/copy-prompt-button.jsx and snippets/setup-flow.jsx

Publication blockers

  • Detached GitHub Check writeback is not yet enabled for all Checkly accounts. Keep this PR unmerged until the global rollout is confirmed; the public guide intentionally does not expose the internal rollout mechanism.
  • The separate preview-checks workflow times out before running documentation checks because it only recognizes *.mintlify.app, while the ready preview comment uses *.mintlify.site. This is unrelated to the documentation content and should be fixed separately.

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jul 15, 2026, 4:12 PM

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