From c34cd01af56b57863b25152c2fbd38b22d50023b Mon Sep 17 00:00:00 2001 From: Herve Labas Date: Mon, 6 Jul 2026 14:03:06 +0200 Subject: [PATCH] Add Checkly GitHub App link to fallback warning --- README.md | 4 +++- scripts/run.sh | 6 ++++-- scripts/test.sh | 1 + 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 09ea5ec..792ea21 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,9 @@ CLI, and Checkly posts a GitHub Check that updates when the session finishes. If GitHub Check reporting is unavailable, the action runs without `--detach` and waits for the test session to finish so the GitHub Actions job reports the result. It also uses the CLI GitHub reporter and writes the Checkly summary to -the GitHub Actions step summary. +the GitHub Actions step summary. Install the +[Checkly GitHub App](https://github.com/apps/checkly) on the repository to run +detached and receive a Checkly GitHub Check instead. For `deployment_status` workflows, the action exposes `github.event.deployment_status.environment_url` as `ENVIRONMENT_URL` when that diff --git a/scripts/run.sh b/scripts/run.sh index 4bd5e94..3a4b2a0 100755 --- a/scripts/run.sh +++ b/scripts/run.sh @@ -1,6 +1,8 @@ #!/usr/bin/env bash set -Eeuo pipefail +CHECKLY_GITHUB_APP_URL="https://github.com/apps/checkly" + trim() { local value="$1" value="${value#"${value%%[![:space:]]*}"}" @@ -426,7 +428,7 @@ elif truthy "${INPUT_GITHUB_REPORT:-true}"; then else clear_github_report_env if [[ "${GITHUB_ACTIONS:-}" == "true" ]]; then - echo "::warning::Checkly GitHub App reporting is unavailable (${github_report_reason}). Running without --detach so this GitHub Actions job waits for the Checkly test session result. Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check instead." + echo "::warning::Checkly GitHub App reporting is unavailable (${github_report_reason}). Running without --detach so this GitHub Actions job waits for the Checkly test session result. Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check instead: ${CHECKLY_GITHUB_APP_URL}" fi fi fi @@ -536,7 +538,7 @@ if [[ "$github_report_requested" == "true" && "$github_report_available" == "tru append_summary "GitHub Check reporting is enabled for this run." elif [[ "$github_report_requested" == "true" ]]; then append_summary "" - append_summary "GitHub Check reporting was unavailable (${github_report_reason}). This job waited for the Checkly run to finish. Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check." + append_summary "GitHub Check reporting was unavailable (${github_report_reason}). This job waited for the Checkly run to finish. [Install the Checkly GitHub App](${CHECKLY_GITHUB_APP_URL}) on this repository to run detached and receive a Checkly GitHub Check." fi rm -f "$output_file" diff --git a/scripts/test.sh b/scripts/test.sh index fd243c7..887661e 100755 --- a/scripts/test.sh +++ b/scripts/test.sh @@ -83,6 +83,7 @@ fallback_command_output="$( assert_contains "$fallback_command_output" "checkly@8.12.0 test --reporter=github" assert_contains "$fallback_command_output" "GitHub report: unavailable (github_app_not_connected), waiting for CLI result" +assert_contains "$fallback_command_output" "Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check instead: https://github.com/apps/checkly" # An old pinned CLI must fall back (skipping the preflight entirely), not fail # the job: CHECKLY_ACTION_GITHUB_REPORT_AVAILABLE=true would force the detached