Skip to content

Commit 57a68aa

Browse files
gustavoliranickboldt
gustavolira
and
nickboldt
authored
chore(e2): rhidp-6404 Add image check and relevant changes action to workflows (#2575)
* RHIDP-6404 Add image check and relevant changes action to workflows Introduce a reusable `check-image-and-changes` composite action to determine if an image already exists and prioritize relevant changes for builds. Update workflows to integrate this action, conditionally triggering builds based on its outputs to optimize build processes. Signed-off-by: Gustavo Lira <[email protected]> * Use specific commit SHAs for GitHub Actions and improve outputs Signed-off-by: Gustavo Lira <[email protected]> * Refactor PR image build workflow to improve checks. Reorganized the workflow to include a dedicated job for checking image existence and relevant changes before building the image. Improved the logic for skipping builds when conditions are met and updated outputs to streamline data flow across steps. Removed repetitive actions and enhanced modularity for better maintainability. Signed-off-by: Gustavo Lira <[email protected]> * Update workflow dependencies and improve build notification Signed-off-by: Gustavo Lira <[email protected]> * Refactor GitHub Actions to ensure jobs always run Modified workflow logic to always execute build and test jobs. Added checks to conditionally skip execution when no relevant changes are detected. Signed-off-by: Gustavo Lira <[email protected]> * Refactor GitHub Actions to ensure jobs always run Modified workflow logic to always execute build and test jobs. Added checks to conditionally skip execution when no relevant changes are detected. Signed-off-by: Gustavo Lira <[email protected]> * Refactor GitHub Actions to ensure jobs always run Modified workflow logic to always execute build and test jobs. Added checks to conditionally skip execution when no relevant changes are detected. Signed-off-by: Gustavo Lira <[email protected]> * Update actions and add new CI checks to pr.yaml workflow Signed-off-by: Gustavo Lira <[email protected]> * Update .github/actions/check-image-and-changes/action.yaml --------- Signed-off-by: Gustavo Lira <[email protected]> Co-authored-by: Nick Boldt <[email protected]>
1 parent 1e50167 commit 57a68aa

File tree

3 files changed

+92
-44
lines changed

3 files changed

+92
-44
lines changed

‎.github/actions/check-image-and-changes/action.yaml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "Check Image and Relevant Changes"
2+
description: "Checks if the image already exists and if changes are relevant"
3+
4+
outputs:
5+
image_exists:
6+
description: "True if the image already exists"
7+
value: ${{ steps.image-check.outputs.exists }}
8+
relevant_changes:
9+
description: "True if changes require a build"
10+
value: ${{ steps.changes.outputs.relevant }}
11+
short_sha:
12+
description: "Short SHA of the latest commit"
13+
value: ${{ steps.get-sha.outputs.short_sha }}
14+
15+
runs:
16+
using: "composite"
17+
steps:
18+
- name: Get the last commit short SHA of the PR
19+
id: get-sha
20+
uses: ./.github/actions/get-sha # Use existing action
21+
22+
- name: Check if Image Already Exists
23+
id: image-check
24+
shell: bash
25+
run: |
26+
IMAGE_TAG_COMMIT="pr-${{ github.event.number }}-${{ steps.get-sha.outputs.short_sha }}"
27+
IMAGE_NAME_COMMIT="${{ env.REGISTRY }}/rhdh-community/rhdh:${IMAGE_TAG_COMMIT}"
28+
29+
IMAGE_EXISTS_COMMIT=$(curl -s "https://quay.io/api/v1/repository/rhdh-community/rhdh/tag/" | jq -r --arg tag "$IMAGE_TAG_COMMIT" '.tags[] | select(.name == $tag) | .name')
30+
31+
if [ -n "$IMAGE_EXISTS_COMMIT" ]; then
32+
echo "Image $IMAGE_NAME_COMMIT already exists."
33+
echo "exists=true" >> $GITHUB_OUTPUT
34+
else
35+
echo "Image $IMAGE_NAME_COMMIT does not exist."
36+
echo "exists=false" >> $GITHUB_OUTPUT
37+
fi
38+
39+
- name: Determine Changed Files
40+
id: changes
41+
shell: bash
42+
run: |
43+
BASE_COMMIT=${{ github.event.pull_request.base.sha }}
44+
HEAD_COMMIT=${{ github.event.pull_request.head.sha }}
45+
46+
CHANGED_FILES=$(git diff --name-only "$BASE_COMMIT" "$HEAD_COMMIT")
47+
48+
echo "Changed files:"
49+
echo "$CHANGED_FILES"
50+
51+
if echo "$CHANGED_FILES" | grep -qvE '^(e2e-tests/|\.ibm/)'; then
52+
echo "Changes detected outside the e2e-tests or .ibm folders. Build required."
53+
echo "relevant=true" >> $GITHUB_OUTPUT
54+
else
55+
echo "No relevant changes detected."
56+
echo "relevant=false" >> $GITHUB_OUTPUT
57+
fi

‎.github/workflows/pr-build-image.yaml

+13-44
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,17 @@ jobs:
4343
ref: ${{ github.event.pull_request.head.ref }}
4444
repository: ${{ github.event.pull_request.head.repo.full_name }}
4545

46+
- name: Check Image and Relevant Changes
47+
id: check-image
48+
uses: ./.github/actions/check-image-and-changes
49+
50+
- name: Check if build should be skipped
51+
run: |
52+
if [[ "${{ steps.check-image.outputs.relevant_changes }}" == "false" && "${{ steps.check-image.outputs.image_exists }}" == "true" ]]; then
53+
echo "::notice::Skipping build: Image already exists and no relevant changes detected."
54+
exit 0
55+
fi
56+
4657
- name: Get the latest commits from base branch
4758
run: |
4859
git remote add base-origin https://github.com/${{ github.repository }} || true
@@ -52,69 +63,27 @@ jobs:
5263
git fetch base-origin ${{ github.event.pull_request.base.ref }}
5364
git merge --no-edit base-origin/${{ github.event.pull_request.base.ref }}
5465
55-
- name: Get the last commit short SHA of the PR
56-
uses: ./.github/actions/get-sha
57-
58-
- name: Check if Image Already Exists
59-
id: image-check
60-
run: |
61-
IMAGE_TAG_COMMIT="pr-${{ github.event.number }}-${{ env.SHORT_SHA }}"
62-
IMAGE_NAME_COMMIT="${{ env.REGISTRY }}/rhdh-community/rhdh:${IMAGE_TAG_COMMIT}"
63-
64-
# Check if any image exists for the specific commit
65-
IMAGE_EXISTS_COMMIT=$(curl -s "https://quay.io/api/v1/repository/rhdh-community/rhdh/tag/" | jq -r --arg tag "$IMAGE_TAG_COMMIT" '.tags[] | select(.name == $tag) | .name')
66-
67-
if [ -n "$IMAGE_EXISTS_COMMIT" ]; then
68-
echo "Image $IMAGE_NAME_COMMIT already exists for the current commit."
69-
echo "image_exists=true" >> $GITHUB_ENV
70-
else
71-
echo "Image $IMAGE_NAME_COMMIT does not exist for the current commit."
72-
echo "image_exists=false" >> $GITHUB_ENV
73-
fi
74-
75-
- name: Determine Changed Files
76-
id: changes
77-
run: |
78-
BASE_COMMIT=${{ github.event.pull_request.base.sha }}
79-
HEAD_COMMIT=${{ github.event.pull_request.head.sha }}
80-
81-
CHANGED_FILES=$(git diff --name-only "$BASE_COMMIT" "$HEAD_COMMIT")
82-
83-
echo "Changed files:"
84-
echo "$CHANGED_FILES"
85-
86-
# Check if changes are only in .ibm/ or e2e-tests/
87-
if echo "$CHANGED_FILES" | grep -qvE '^(e2e-tests/|\.ibm/)'; then
88-
echo "Changes detected outside the e2e-tests or .ibm folders. Build required."
89-
echo "relevant_changes=true" >> $GITHUB_ENV
90-
else
91-
echo "No relevant changes detected."
92-
echo "relevant_changes=false" >> $GITHUB_ENV
93-
fi
94-
9566
- name: Build and Push with Buildx
96-
if: env.relevant_changes == 'true' && env.image_exists == 'false'
9767
uses: ./.github/actions/docker-build
9868
with:
9969
registry: ${{ env.REGISTRY }}
10070
username: ${{ secrets.QUAY_USERNAME }}
10171
password: ${{ secrets.QUAY_TOKEN }}
10272
imageName: rhdh-community/rhdh
10373
imageTags: |
104-
type=ref,prefix=pr-,suffix=-${{ env.SHORT_SHA }},event=pr
74+
type=ref,prefix=pr-,suffix=-${{ steps.check-image.outputs.short_sha }},event=pr
10575
type=ref,prefix=pr-,event=pr
10676
imageLabels: quay.expires-after=14d
10777
push: true
10878
platform: linux/amd64
10979

11080
- name: Comment the image pull link
111-
if: env.relevant_changes == 'true' && env.image_exists == 'false'
11281
uses: actions/github-script@v7
11382
with:
11483
script: |
11584
github.rest.issues.createComment({
11685
issue_number: context.issue.number,
11786
owner: context.repo.owner,
11887
repo: context.repo.repo,
119-
body: 'The image is available at:\n* [`quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}`](https://quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}) or\n* [`quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}-${{ env.SHORT_SHA }}`](https://quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}-${{ env.SHORT_SHA }})'
88+
body: 'The image is available at:\n* [`quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}`](https://quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}) or\n* [`quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}-${{ steps.check-image.outputs.short_sha }}`](https://quay.io/rhdh-community/rhdh:pr-${{ github.event.number }}-${{ steps.check-image.outputs.short_sha }})'
12089
})

‎.github/workflows/pr.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ jobs:
3838
with:
3939
fetch-depth: 0
4040

41+
- name: Check Image and Relevant Changes
42+
id: check-image
43+
uses: ./.github/actions/check-image-and-changes
44+
45+
- name: Check if build should be skipped
46+
run: |
47+
if [[ "${{ steps.check-image.outputs.relevant_changes }}" == "false" && "${{ steps.check-image.outputs.image_exists }}" == "true" ]]; then
48+
echo "Skipping build: Image already exists and no relevant changes detected."
49+
exit 0
50+
fi
51+
4152
- name: Setup Node.js
4253
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
4354
with:
@@ -70,6 +81,17 @@ jobs:
7081
with:
7182
fetch-depth: 0
7283

84+
- name: Check Image and Relevant Changes
85+
id: check-image
86+
uses: ./.github/actions/check-image-and-changes
87+
88+
- name: Check if tests should be skipped
89+
run: |
90+
if [[ "${{ steps.check-image.outputs.relevant_changes }}" == "false" && "${{ steps.check-image.outputs.image_exists }}" == "true" ]]; then
91+
echo "Skipping tests: No relevant changes detected."
92+
exit 0
93+
fi
94+
7395
- name: Setup Node.js
7496
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
7597
with:

0 commit comments

Comments
 (0)