ci: add preview janitor and recreate control #2930
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| #!/usr/bin/env bash | ||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| # shellcheck source=.github/scripts/preview/common.sh | ||
| source "${SCRIPT_DIR}/common.sh" | ||
|
|
||
| require_env_vars \ | ||
| RAILWAY_API_TOKEN \ | ||
| RAILWAY_PROJECT_ID \ | ||
| GH_TOKEN \ | ||
| GITHUB_REPOSITORY | ||
|
|
||
| DRY_RUN="${DRY_RUN:-false}" | ||
| DELETE_UNKNOWN_PREVIEW_ENVS="${DELETE_UNKNOWN_PREVIEW_ENVS:-false}" | ||
|
|
||
| github_pr_state() { | ||
| local pr_number="$1" | ||
| local response_file="" | ||
| local status="" | ||
|
|
||
| response_file="$(mktemp)" | ||
| status="$( | ||
| curl -sS \ | ||
| --connect-timeout 10 \ | ||
| --max-time 30 \ | ||
| -o "${response_file}" \ | ||
| -w '%{http_code}' \ | ||
| -H "Authorization: Bearer ${GH_TOKEN}" \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| "https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/${pr_number}" | ||
| )" | ||
|
|
||
| case "${status}" in | ||
| 200) | ||
| jq -r '.state' "${response_file}" | ||
| ;; | ||
| 404) | ||
| printf 'missing' | ||
| ;; | ||
| *) | ||
| echo "Failed to query PR #${pr_number} from GitHub API (HTTP ${status})." >&2 | ||
| cat "${response_file}" >&2 | ||
| rm -f "${response_file}" | ||
| return 1 | ||
| ;; | ||
| esac | ||
|
|
||
| rm -f "${response_file}" | ||
| } | ||
|
|
||
| delete_env_and_verify() { | ||
| local env_id="$1" | ||
| local env_name="$2" | ||
|
|
||
| preview_log "Deleting stale Railway preview environment ${env_name}." | ||
| railway_environment_delete_by_id "${env_id}" >/dev/null | ||
| railway_wait_for_environment_absent "${RAILWAY_PROJECT_ID}" "${env_name}" 10 2 | ||
| } | ||
|
Contributor
There was a problem hiding this comment. 🟠 MAJOR: Deletion errors are silently ignored Issue: Why: When debugging deletion failures, operators see "Railway environment still exists after waiting for deletion" but won't know why (permission denied, API error, rate limit). The actual Railway API error is discarded. Fix: Check the return status before proceeding: delete_env_and_verify() {
local env_id="$1"
local env_name="$2"
preview_log "Deleting stale Railway preview environment ${env_name}."
if ! railway_environment_delete_by_id "${env_id}"; then
echo "Failed to delete Railway environment ${env_name}." >&2
return 1
fi
railway_wait_for_environment_absent "${RAILWAY_PROJECT_ID}" "${env_name}" 10 2
}Refs:
|
||
|
|
||
| ENVIRONMENTS_JSON="$(railway_project_environments_json "${RAILWAY_PROJECT_ID}")" | ||
| PR_ENVIRONMENTS_JSON="$(jq -c '[.[] | select(.name | test("^pr-[0-9]+$"))]' <<< "${ENVIRONMENTS_JSON}")" | ||
| PR_ENVIRONMENT_COUNT="$(jq 'length' <<< "${PR_ENVIRONMENTS_JSON}")" | ||
|
|
||
| if [ "${PR_ENVIRONMENT_COUNT}" = "0" ]; then | ||
| preview_log "No Railway PR environments found in project ${RAILWAY_PROJECT_ID}." | ||
| exit 0 | ||
| fi | ||
|
|
||
| preview_log "Evaluating ${PR_ENVIRONMENT_COUNT} Railway PR environment(s) for stale state." | ||
|
|
||
| deleted=0 | ||
| kept=0 | ||
| unknown_seen=0 | ||
| unknown_skipped=0 | ||
| stale_targets=0 | ||
| errors=0 | ||
| deleted_names=() | ||
| unknown_names=() | ||
|
|
||
| while IFS= read -r row; do | ||
| [ -z "${row}" ] && continue | ||
|
|
||
| env_id="$(jq -r '.id' <<< "${row}")" | ||
| env_name="$(jq -r '.name' <<< "${row}")" | ||
| pr_number="${env_name#pr-}" | ||
|
|
||
| pr_state="$(github_pr_state "${pr_number}")" || { | ||
| errors=$((errors + 1)) | ||
| continue | ||
| } | ||
|
|
||
| case "${pr_state}" in | ||
| open) | ||
| kept=$((kept + 1)) | ||
| ;; | ||
| closed) | ||
| stale_targets=$((stale_targets + 1)) | ||
| if [ "${DRY_RUN}" = "true" ]; then | ||
| preview_log "[dry-run] Would delete stale Railway preview environment ${env_name}." | ||
| else | ||
| delete_env_and_verify "${env_id}" "${env_name}" | ||
| deleted=$((deleted + 1)) | ||
| deleted_names+=("${env_name}") | ||
| fi | ||
|
Comment on lines
+105
to
+113
Contributor
There was a problem hiding this comment. 🟠 MAJOR: Deletion failures not tracked in exit code Issue: When Why: The janitor could fail to delete multiple Railway environments due to API issues, but exit with code 0 if all GitHub PR lookups succeeded. Operators checking CI may incorrectly believe all targeted environments were cleaned up. Fix: Add a # Add at line 77 with other counters:
deletion_failures=0
# In the delete blocks (lines 100-105 and 113-118):
if ! delete_env_and_verify "${env_id}" "${env_name}"; then
deletion_failures=$((deletion_failures + 1))
else
deleted=$((deleted + 1))
deleted_names+=("${env_name}")
fi
# Update exit check at line 153:
if [ "${errors}" -gt 0 ] || [ "${deletion_failures}" -gt 0 ]; then
echo "Encountered ${errors} GitHub lookup error(s) and ${deletion_failures} Railway deletion failure(s)." >&2
exit 1
fi |
||
| ;; | ||
| missing) | ||
| unknown_seen=$((unknown_seen + 1)) | ||
| unknown_names+=("${env_name}") | ||
| if [ "${DELETE_UNKNOWN_PREVIEW_ENVS}" = "true" ]; then | ||
| stale_targets=$((stale_targets + 1)) | ||
| if [ "${DRY_RUN}" = "true" ]; then | ||
| preview_log "[dry-run] Would delete orphaned Railway preview environment ${env_name}." | ||
| else | ||
| delete_env_and_verify "${env_id}" "${env_name}" | ||
| deleted=$((deleted + 1)) | ||
| deleted_names+=("${env_name}") | ||
| fi | ||
| else | ||
| unknown_skipped=$((unknown_skipped + 1)) | ||
| preview_log "Leaving Railway preview environment ${env_name} in place because GitHub PR lookup returned 404." | ||
| fi | ||
| ;; | ||
| *) | ||
| echo "Unexpected GitHub PR state for #${pr_number}: ${pr_state}" >&2 | ||
| errors=$((errors + 1)) | ||
| ;; | ||
| esac | ||
| done < <(jq -rc '.[]' <<< "${PR_ENVIRONMENTS_JSON}") | ||
|
|
||
| if [ -n "${GITHUB_STEP_SUMMARY:-}" ]; then | ||
| { | ||
| echo "## Railway Preview Janitor" | ||
| echo "- Dry run: \`${DRY_RUN}\`" | ||
| echo "- Evaluated PR envs: \`${PR_ENVIRONMENT_COUNT}\`" | ||
| echo "- Open PR envs kept: \`${kept}\`" | ||
| echo "- Closed/orphaned PR envs targeted: \`${stale_targets}\`" | ||
| echo "- Railway envs deleted: \`${deleted}\`" | ||
| echo "- Unknown PR envs seen: \`${unknown_seen}\`" | ||
| echo "- Unknown PR envs left in place: \`${unknown_skipped}\`" | ||
| echo "- GitHub lookup errors: \`${errors}\`" | ||
| if [ "${deleted}" -gt 0 ]; then | ||
| echo "- Deleted envs: \`${deleted_names[*]}\`" | ||
| fi | ||
| if [ "${unknown_seen}" -gt 0 ]; then | ||
| echo "- Unknown envs encountered: \`${unknown_names[*]}\`" | ||
| fi | ||
| } >> "${GITHUB_STEP_SUMMARY}" | ||
| fi | ||
|
|
||
| if [ "${errors}" -gt 0 ]; then | ||
| echo "Encountered ${errors} GitHub lookup error(s) during Railway preview janitor." >&2 | ||
| exit 1 | ||
| fi | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The GitHub PR lookup is hard-coded to
https://api.github.com/.... GitHub Actions exposesGITHUB_API_URL(and this also matters for GHES); consider building the endpoint from${GITHUB_API_URL}(fallbacking to api.github.com) to avoid breaking the janitor in non-public-GitHub contexts.