-
Notifications
You must be signed in to change notification settings - Fork 498
NO-JIRA: feat(skills): add validate-pr-override-images skill #8616
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.
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
openshift-merge-bot
merged 1 commit into
openshift:main
from
enxebre:enxebre/validate-pr-images-skill
Jun 3, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| description: Validates that CPO override images in a PR actually contain the PRs they claim to include | ||
| argument-hint: "<PR-URL-or-number>" | ||
| --- | ||
|
|
||
| ## Name | ||
| validate-pr-override-images | ||
|
|
||
| ## Synopsis | ||
| ```text | ||
| /validate-pr-override-images <PR-URL-or-number> | ||
| ``` | ||
|
|
||
| ## Description | ||
| Validates that CPO override images in a PR actually contain the claimed fix PRs. | ||
|
|
||
| The PR description must include a structured contract: | ||
| ``` | ||
| branch: 4.20 wants: https://github.com/openshift/hypershift/pull/8593 | ||
| branch: 4.21 wants: https://github.com/openshift/hypershift/pull/8593, https://github.com/openshift/hypershift/pull/8565 | ||
| ``` | ||
|
|
||
| Prerequisites: | ||
| - `skopeo` must be installed (`brew install skopeo` on macOS) | ||
| - The local git repo must have the relevant release branches fetched | ||
| - Images must be accessible from quay.io | ||
|
|
||
| ## Implementation | ||
|
|
||
| Extract the PR number from the argument, then run: | ||
| ```bash | ||
| .claude/skills/validate-pr-override-images/validate-overrides.sh <pr-number> | ||
| ``` | ||
|
|
||
| Report the output to the user. | ||
|
|
||
| ## Arguments | ||
| - `$1`: PR URL (e.g., `https://github.com/openshift/hypershift/pull/8610`) or PR number (e.g., `8610`) |
179 changes: 179 additions & 0 deletions
179
.claude/skills/validate-pr-override-images/validate-overrides.sh
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,179 @@ | ||
| #!/bin/bash | ||
| # validate-overrides.sh | ||
| # Parses a PR description for the override contract (branch: X.Y wants: PR-links), | ||
| # extracts override images from the diff, and validates each image contains the claimed PRs. | ||
| # Usage: ./validate-overrides.sh <pr-number> [repo] | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| REPO_ROOT="$(cd "$SCRIPT_DIR/../../.." && pwd)" | ||
|
|
||
| if [[ $# -lt 1 || $# -gt 2 ]]; then | ||
| echo "Usage: $0 <pr-number> [repo]" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| PR="$1" | ||
| GH_REPO="${2:-openshift/hypershift}" | ||
|
|
||
| echo "=== Validating CPO override images for PR #${PR} ===" | ||
| echo "" | ||
|
|
||
| # Step 1: Parse PR description for the contract | ||
| echo "--- Step 1: Parsing PR description ---" | ||
| BODY=$(gh pr view "$PR" --repo "$GH_REPO" --json body -q .body | tr -d '\r') | ||
|
|
||
| BRANCH_LIST="" | ||
| FOUND_LINES=0 | ||
| in_code_block=false | ||
|
|
||
| while IFS= read -r line; do | ||
| if [[ "$line" == '```'* ]]; then | ||
| if $in_code_block; then | ||
| in_code_block=false | ||
| else | ||
| in_code_block=true | ||
| fi | ||
| continue | ||
| fi | ||
| if $in_code_block; then | ||
| continue | ||
| fi | ||
|
|
||
| lower_line=$(echo "$line" | tr '[:upper:]' '[:lower:]') | ||
| if [[ ! "$lower_line" == *branch:*wants:* ]]; then | ||
| continue | ||
| fi | ||
|
|
||
| branch=$(echo "$line" | sed -n 's/^[[:space:]]*[bB][rR][aA][nN][cC][hH]:[[:space:]]*\([0-9]*\.[0-9]*\)[[:space:]]*[wW][aA][nN][tT][sS]:[[:space:]]*\(.*\)$/\1/p') | ||
| wants=$(echo "$line" | sed -n 's/^[[:space:]]*[bB][rR][aA][nN][cC][hH]:[[:space:]]*[0-9]*\.[0-9]*[[:space:]]*[wW][aA][nN][tT][sS]:[[:space:]]*\(.*\)$/\1/p') | ||
|
|
||
| if [[ -n "$branch" && -n "$wants" ]]; then | ||
| FOUND_LINES=$((FOUND_LINES + 1)) | ||
| pr_numbers="" | ||
| for url in $(echo "$wants" | tr ',' ' '); do | ||
| url=$(echo "$url" | xargs) | ||
| num=$(echo "$url" | grep -oE '[0-9]+$' || true) | ||
| if [[ -n "$num" ]]; then | ||
| if [[ -n "$pr_numbers" ]]; then | ||
| pr_numbers="$pr_numbers $num" | ||
| else | ||
| pr_numbers="$num" | ||
| fi | ||
| fi | ||
| done | ||
| if [[ -z "$pr_numbers" ]]; then | ||
| echo "ERROR: branch $branch has 'wants:' but no valid PR numbers could be parsed" | ||
| exit 1 | ||
| fi | ||
| BRANCH_LIST="${BRANCH_LIST}${branch}=${pr_numbers} | ||
| " | ||
| echo " branch $branch wants PRs: $pr_numbers" | ||
| fi | ||
| done <<< "$BODY" | ||
|
|
||
| if [[ $FOUND_LINES -eq 0 ]]; then | ||
| echo "" | ||
| echo "ERROR: No 'branch: X.Y wants: <PR-links>' lines found in PR description." | ||
| echo "" | ||
| echo "The PR description must include lines like:" | ||
| echo " branch: 4.19 wants: https://github.com/openshift/hypershift/pull/1234" | ||
| echo " branch: 4.20 wants: https://github.com/openshift/hypershift/pull/1234, https://github.com/openshift/hypershift/pull/5678" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "" | ||
|
|
||
| # Step 2: Extract images per branch from the diff | ||
| echo "--- Step 2: Extracting override images from diff ---" | ||
| DIFF=$(gh pr diff "$PR" --repo "$GH_REPO") | ||
|
|
||
| IMAGE_LIST="" | ||
| current_version="" | ||
|
|
||
| while IFS= read -r line; do | ||
| version_match=$(echo "$line" | sed -n 's/^[+ ].*version:[[:space:]]*\([0-9]*\.[0-9]*\)\.[0-9]*.*/\1/p') | ||
| if [[ -n "$version_match" ]]; then | ||
| current_version="$version_match" | ||
| fi | ||
|
|
||
| image_match=$(echo "$line" | sed -n 's/^+.*cpoImage:[[:space:]]*\(.*\)/\1/p') | ||
| image_match="${image_match#"${image_match%%[![:space:]]*}"}" | ||
| image_match="${image_match%"${image_match##*[![:space:]]}"}" | ||
| if [[ -n "$image_match" && -n "$current_version" ]]; then | ||
| entry="${current_version}=${image_match}" | ||
| if [[ "$IMAGE_LIST" != *"$entry"* ]]; then | ||
| IMAGE_LIST="${IMAGE_LIST}${entry} | ||
| " | ||
| fi | ||
| fi | ||
| done <<< "$DIFF" | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| echo "$IMAGE_LIST" | while IFS= read -r entry; do | ||
| if [[ -n "$entry" ]]; then | ||
| branch="${entry%%=*}" | ||
| image="${entry#*=}" | ||
| echo " branch $branch image: $image" | ||
| fi | ||
| done | ||
|
|
||
| echo "" | ||
|
|
||
| # Step 3: Validate each (branch, image, PR) tuple | ||
| echo "--- Step 3: Validating images contain claimed PRs ---" | ||
| echo "" | ||
|
|
||
| echo "$BRANCH_LIST" | while IFS= read -r branch_entry; do | ||
| if [[ -z "$branch_entry" ]]; then | ||
| continue | ||
| fi | ||
| branch="${branch_entry%%=*}" | ||
| prs="${branch_entry#*=}" | ||
|
|
||
| branch_images=$(echo "$IMAGE_LIST" | grep "^${branch}=" | sed "s/^${branch}=//" | sort -u) | ||
|
|
||
| if [[ -z "$branch_images" ]]; then | ||
| echo "WARNING: branch $branch declared in description but no override images found in diff" | ||
| echo "FAILURE_COUNT:1" | ||
| continue | ||
| fi | ||
|
|
||
| echo "$branch_images" | while IFS= read -r image; do | ||
| if [[ -z "$image" ]]; then | ||
| continue | ||
| fi | ||
| echo "Image: $image (branch $branch)" | ||
| for pr_num in $prs; do | ||
| verify_output=$("$SCRIPT_DIR/verify-pr-in-image.sh" "$image" "$pr_num" "$REPO_ROOT" 2>&1) && verify_rc=0 || verify_rc=$? | ||
| echo "$verify_output" | sed 's/^/ /' | ||
| if echo "$verify_output" | tail -1 | grep -q "PASS"; then | ||
| echo " PR #${pr_num}: PASS" | ||
| echo "PASS_COUNT:1" | ||
| else | ||
| echo " PR #${pr_num}: FAIL" | ||
| echo "FAILURE_COUNT:1" | ||
| fi | ||
| done | ||
| echo "" | ||
| done | ||
| done > /tmp/validate-overrides-output.$$ | ||
|
|
||
| grep -v "COUNT:" /tmp/validate-overrides-output.$$ | ||
| PASSES=$(grep -c "PASS_COUNT:" /tmp/validate-overrides-output.$$ || true) | ||
| FAILURES=$(grep -c "FAILURE_COUNT:" /tmp/validate-overrides-output.$$ || true) | ||
| rm -f /tmp/validate-overrides-output.$$ | ||
|
|
||
| # Summary | ||
| echo "=== Summary ===" | ||
| echo "Passed: $PASSES" | ||
| echo "Failed: $FAILURES" | ||
|
|
||
| if [[ $FAILURES -gt 0 ]]; then | ||
| echo "" | ||
| echo "OVERALL: FAIL" | ||
| exit 1 | ||
| else | ||
| echo "" | ||
| echo "OVERALL: PASS" | ||
| fi | ||
69 changes: 69 additions & 0 deletions
69
.claude/skills/validate-pr-override-images/verify-pr-in-image.sh
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,69 @@ | ||
| #!/bin/bash | ||
| # verify-pr-in-image.sh | ||
| # Verifies that a container image contains a specific PR in its git history. | ||
| # Usage: ./verify-pr-in-image.sh <image> <pr-number> [repo-path] | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| if [[ $# -lt 2 || $# -gt 3 ]]; then | ||
| echo "Usage: $0 <image> <pr-number> [repo-path]" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| IMAGE="$1" | ||
| PR="$2" | ||
| REPO="${3:-.}" | ||
|
enxebre marked this conversation as resolved.
|
||
|
|
||
| if ! command -v skopeo &>/dev/null; then | ||
| echo "ERROR: skopeo is not installed. Install it with: brew install skopeo (macOS) or dnf install skopeo (RHEL/Fedora)" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Inspecting image..." | ||
| INSPECT=$(skopeo inspect --override-os linux --override-arch amd64 "docker://$IMAGE") || { | ||
| echo "ERROR: Could not inspect image $IMAGE" | ||
| exit 1 | ||
| } | ||
|
|
||
| COMMIT=$(echo "$INSPECT" | grep -o '"vcs-ref"[[:space:]]*:[[:space:]]*"[^"]*"' | head -1 | sed 's/.*"vcs-ref"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/') | ||
|
|
||
| if [[ -z "$COMMIT" ]]; then | ||
| echo "ERROR: Could not find vcs-ref label in image $IMAGE" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Image commit: $COMMIT" | ||
|
|
||
| if ! git -C "$REPO" cat-file -e "$COMMIT" 2>/dev/null; then | ||
| echo "Commit not found locally, fetching..." | ||
| git -C "$REPO" fetch --all --quiet | ||
| if ! git -C "$REPO" cat-file -e "$COMMIT" 2>/dev/null; then | ||
| echo "ERROR: Commit $COMMIT not found in any remote" | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| PR_MERGE_COMMIT=$(gh pr view "$PR" --repo openshift/hypershift --json mergeCommit --jq '.mergeCommit.oid // empty') | ||
|
|
||
| if [[ -z "$PR_MERGE_COMMIT" ]]; then | ||
| echo "FAIL: PR #${PR} has no merge commit (not merged yet?)" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "PR #${PR} merge commit: $PR_MERGE_COMMIT" | ||
|
|
||
| if ! git -C "$REPO" cat-file -e "$PR_MERGE_COMMIT" 2>/dev/null; then | ||
| echo "Merge commit not found locally, fetching..." | ||
| git -C "$REPO" fetch --all --quiet | ||
| if ! git -C "$REPO" cat-file -e "$PR_MERGE_COMMIT" 2>/dev/null; then | ||
| echo "ERROR: PR #${PR} merge commit $PR_MERGE_COMMIT not found in any remote" | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| if git -C "$REPO" merge-base --is-ancestor "$PR_MERGE_COMMIT" "$COMMIT" 2>/dev/null; then | ||
| echo "PASS: PR #${PR} is included in image $IMAGE" | ||
| else | ||
| echo "FAIL: PR #${PR} is NOT included in image $IMAGE" | ||
| 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: Validate CPO Overrides | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'hypershift-operator/controlplaneoperator-overrides/assets/overrides.yaml' | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: read | ||
|
|
||
| jobs: | ||
| validate-cpo-overrides: | ||
| name: Validate CPO Override Images | ||
| runs-on: arc-runner-set | ||
| timeout-minutes: 30 | ||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| fetch-depth: 0 | ||
| persist-credentials: false | ||
| - name: Validate override images | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| run: .claude/skills/validate-pr-override-images/validate-overrides.sh "${{ github.event.pull_request.number }}" |
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.
Uh oh!
There was an error while loading. Please reload this page.