Skip to content

Add GitHub report fallback handling #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thebiglabasky merged 1 commit into from
Jul 6, 2026
Merged

Add GitHub report fallback handling #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions scripts/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:]]*}"}"
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
1 change: 1 addition & 0 deletions scripts/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading