Skip to content

Link GitHub App setup through Checkly #7

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 16, 2026
Merged

Link GitHub App setup through Checkly #7

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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ The `reporting` input controls where the Checkly result is reported:
- `github-actions`: always wait in the GitHub Actions job and report through the
CLI GitHub reporter and step summary.

Install the [Checkly GitHub App](https://github.com/apps/checkly) on the
repository to use detached GitHub Check reporting.
Install the [Checkly GitHub App](https://app.checklyhq.com/settings/account/integrations)
from your Checkly account integrations and grant it access to the repository to
use detached GitHub Check reporting.

For `deployment_status` workflows, the action exposes
`github.event.deployment_status.environment_url` as `ENVIRONMENT_URL` when that
Expand Down
8 changes: 4 additions & 4 deletions scripts/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -Eeuo pipefail

CHECKLY_GITHUB_APP_URL="https://github.com/apps/checkly"
CHECKLY_GITHUB_INTEGRATION_URL="https://app.checklyhq.com/settings/account/integrations"

trim() {
local value="$1"
Expand Down Expand Up @@ -462,10 +462,10 @@ else
else
clear_github_report_env
if [[ "$reporting" == "github-check" ]]; then
echo "::error::Checkly GitHub Check reporting is unavailable (${github_report_reason}). Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check: ${CHECKLY_GITHUB_APP_URL}" >&2
echo "::error::Checkly GitHub Check reporting is unavailable (${github_report_reason}). Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check: ${CHECKLY_GITHUB_INTEGRATION_URL}" >&2
exit 1
elif [[ "${GITHUB_ACTIONS:-}" == "true" ]]; then
echo "::warning::Checkly GitHub Check reporting is unavailable (${github_report_reason}). Reporting through GitHub Actions instead, so this 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: ${CHECKLY_GITHUB_APP_URL}"
echo "::warning::Checkly GitHub Check reporting is unavailable (${github_report_reason}). Reporting through GitHub Actions instead, so this 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: ${CHECKLY_GITHUB_INTEGRATION_URL}"
fi
fi
fi
Expand Down Expand Up @@ -584,7 +584,7 @@ if [[ "$github_check_requested" == "true" && "$github_report_available" == "true
append_summary "GitHub Check reporting is enabled for this run."
elif [[ "$github_check_requested" == "true" ]]; then
append_summary ""
append_summary "GitHub Check reporting was unavailable (${github_report_reason}). This job reported through GitHub Actions and 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."
append_summary "GitHub Check reporting was unavailable (${github_report_reason}). This job reported through GitHub Actions and waited for the Checkly run to finish. [Install the Checkly GitHub App](${CHECKLY_GITHUB_INTEGRATION_URL}) on this repository to run detached and receive a Checkly GitHub Check."
fi

rm -f "$output_file"
Expand Down
2 changes: 1 addition & 1 deletion scripts/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ fallback_command_output="$(

assert_contains "$fallback_command_output" "checkly@8.15.0 test --reporter=github"
assert_contains "$fallback_command_output" "Reporting: GitHub Actions (GitHub Check unavailable: github_app_not_connected)"
assert_contains "$fallback_command_output" "Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check: https://github.com/apps/checkly"
assert_contains "$fallback_command_output" "Install the Checkly GitHub App on this repository to run detached and receive a Checkly GitHub Check: https://app.checklyhq.com/settings/account/integrations"

assert_fails_with "Unsupported reporting 'banana'" env \
INPUT_COMMAND=test \
Expand Down