{"id":51717014,"url":"https://github.com/checkly/checkly-action","last_synced_at":"2026-07-17T04:36:23.688Z","repository":{"id":370481992,"uuid":"1286000573","full_name":"checkly/checkly-action","owner":"checkly","description":null,"archived":false,"fork":false,"pushed_at":"2026-07-09T11:06:40.000Z","size":32,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-09T12:16:12.921Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-07-01T10:50:14.000Z","updated_at":"2026-07-09T10:54:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/checkly/checkly-action","commit_stats":null,"previous_names":["checkly/checkly-action"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/checkly/checkly-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkly","download_url":"https://codeload.github.com/checkly/checkly-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35568173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-17T02:00:06.162Z","response_time":116,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-07-17T04:36:22.901Z","updated_at":"2026-07-17T04:36:23.673Z","avatar_url":"https://github.com/checkly.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checkly GitHub Action\n\nRun Checkly checks from GitHub Actions with the Checkly CLI.\n\nThis action is a small wrapper around `npx checkly@\u003cversion\u003e test` and\n`npx checkly@\u003cversion\u003e trigger`. It keeps the Checkly CLI as the source of truth\nwhile making the common GitHub Actions setup easier to discover.\n\n## Usage\n\nRun local Checkly constructs from the pull request checkout:\n\n```yaml\nname: Checkly\n\non:\n  pull_request:\n\njobs:\n  checkly:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n\n      - uses: checkly/checkly-action@v1\n        with:\n          command: test\n          cli-version: latest\n          install-command: npm ci\n          tags: production,webapp\n          grep: checkout\n          github-check-name: Checkly PR code checks\n        env:\n          CHECKLY_API_KEY: ${{ secrets.CHECKLY_API_KEY }}\n          CHECKLY_ACCOUNT_ID: ${{ vars.CHECKLY_ACCOUNT_ID }}\n```\n\nTrigger deployed checks from Checkly:\n\n```yaml\n- uses: checkly/checkly-action@v1\n  with:\n    command: trigger\n    tags: production\n    check-id: abc123,def456\n  env:\n    CHECKLY_API_KEY: ${{ secrets.CHECKLY_API_KEY }}\n    CHECKLY_ACCOUNT_ID: ${{ vars.CHECKLY_ACCOUNT_ID }}\n```\n\nUse multiple `--tags` filters by putting one filter per line:\n\n```yaml\nwith:\n  command: test\n  tags: |\n    production,webapp\n    production,backend\n```\n\nThe `reporting` input controls where the Checkly result is reported:\n\n- `auto` (default): use a detached run with GitHub Check reporting when the\n  Checkly GitHub App can report on the repository. Otherwise, wait in the\n  GitHub Actions job and report there.\n- `github-check`: require detached GitHub Check reporting. The action fails\n  before running checks if the Checkly GitHub App cannot report on the\n  repository.\n- `github-actions`: always wait in the GitHub Actions job and report through the\n  CLI GitHub reporter and step summary.\n\nInstall the [Checkly GitHub App](https://app.checklyhq.com/settings/account/integrations)\nfrom your Checkly account integrations and grant it access to the repository to\nuse detached GitHub Check reporting.\n\n### CLI resolution\n\nCheckly config files import constructs from the `checkly` package. When the\nworking directory has `checkly` installed, this action runs that local CLI after\n`install-command` completes so the CLI and constructs share the same module\nsession. Keep that project dependency at `8.15.0` or newer for GitHub Check\nreporting.\n\nAn exact stable `cli-version` pin must match the installed project version. For\nexample, a project with `checkly@8.15.0` should use `cli-version: 8.15.0`. The\naction falls back to `npx checkly@\u003ccli-version\u003e` only when the project does not\ninstall Checkly itself.\n\nFor `deployment_status` workflows, the action exposes\n`github.event.deployment_status.environment_url` as `ENVIRONMENT_URL` when that\nenvironment variable is not already set. For pull request preview URLs, pass the\ntarget URL explicitly through `env` or the workflow `env` block.\n\n### Choose the GitHub Check commit\n\nGitHub Checks are attached to a commit, not to a workflow run or deployment.\nFor pull request events, the action targets the pull request head commit. For\nother events, it uses `GITHUB_SHA`.\n\nSet `github-sha` when the commit being tested differs from `GITHUB_SHA`. This is\ncommon in `repository_dispatch` workflows, where the dispatch payload identifies\nthe deployed commit. Use the same SHA for checkout and Check reporting so the\nresult describes the code that actually ran:\n\n```yaml\nname: Validate preview\n\non:\n  repository_dispatch:\n    types: [preview-ready]\n\njobs:\n  checkly:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          ref: ${{ github.event.client_payload.sha }}\n\n      - uses: checkly/checkly-action@v1\n        with:\n          command: test\n          install-command: npm ci\n          github-sha: ${{ github.event.client_payload.sha }}\n          github-check-name: Checkly preview validation\n        env:\n          CHECKLY_API_KEY: ${{ secrets.CHECKLY_API_KEY }}\n          CHECKLY_ACCOUNT_ID: ${{ vars.CHECKLY_ACCOUNT_ID }}\n          ENVIRONMENT_URL: ${{ github.event.client_payload.environment_url }}\n```\n\nThe commit must belong to the current repository. The Checkly backend still\nverifies that the account's GitHub App installation can access that repository;\n`github-sha` is metadata, not authorization. It associates the test session\nwith that commit and selects where the GitHub Check is reported.\n\n## Inputs\n\n| Input | Description |\n| --- | --- |\n| `command` | `test` for local constructs or `trigger` for deployed checks. Defaults to `test`. |\n| `cli-version` | Checkly CLI version. Requires `8.15.0` or newer and defaults to `latest`. When the project installs `checkly`, the local CLI runs instead; exact stable pins must match it. Dist-tags, ranges, canaries, and prereleases are assumed compatible. |\n| `working-directory` | Directory where the CLI command should run. Defaults to `.`. |\n| `install-command` | Optional command to run before the Checkly CLI command, inside `working-directory`. |\n| `tags` | One `--tags` filter per line. Each line can contain comma-separated tags. |\n| `grep` | `test` only. Check name regular expression. |\n| `check-id` | `trigger` only. Comma-separated deployed check IDs. |\n| `files` | `test` only. File-name patterns passed as positional args, one per line. |\n| `config` | Checkly config file path. |\n| `location` | Public run location. |\n| `private-location` | Private run location slug. |\n| `env` | One `KEY=VALUE` per line, passed as repeated `--env` flags. |\n| `env-file` | Dotenv file path. |\n| `test-session-name` | Name to use for the recorded test session. |\n| `timeout` | CLI timeout in seconds. |\n| `retries` | Number of retries. |\n| `refresh-cache` | Pass `--refresh-cache`. |\n| `update-snapshots` | `test` only. Pass `--update-snapshots`. |\n| `verify-runtime-dependencies` | `test` only. Set to `false` to pass `--no-verify-runtime-dependencies`. |\n| `fail-on-no-matching` | `trigger` only. Set to `false` to pass `--no-fail-on-no-matching`. |\n| `verbose` | Set to `true` or `false` to pass `--verbose` or `--no-verbose`. |\n| `reporting` | Where to report the Checkly result: `auto`, `github-check`, or `github-actions`. Defaults to `auto`. |\n| `github-check-name` | GitHub Check name used when reporting through the Checkly GitHub App. Defaults to `Checkly`. |\n| `github-sha` | Commit associated with the test session and targeted by the GitHub Check. Overrides the pull request head SHA or `GITHUB_SHA`. |\n\n## Outputs\n\n| Output | Description |\n| --- | --- |\n| `test-session-id` | Checkly test session ID, when detected from CLI output. |\n| `test-session-url` | Checkly test session URL, when detected from CLI output. |\n\n## Development\n\nThe test harness does not need Checkly or GitHub credentials. It uses a local\npreflight server and a fake CLI process to exercise the complete Action flow.\n\n```sh\nshellcheck scripts/*.sh\n./scripts/test.sh\n./scripts/test-integration.sh\n```\n\nSee `AGENTS.md` for the repository invariants, complete verification commands,\nand release guidance.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fcheckly-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckly%2Fcheckly-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fcheckly-action/lists"}