feat: validate kustomize build of tasks and pipelines #1792
+13,891
−1,433
There are no files selected for viewing
This file contains 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,20 @@ | ||
| name: Validate PR - kustomize manifests | ||
| 'on': | ||
| pull_request: | ||
| branches: [main] | ||
| jobs: | ||
| kustomize-build: | ||
| name: Check Kustomize Build of Task and Pipelines | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out code | ||
| uses: actions/checkout@v4 | ||
| - name: Install oc | ||
| run: | | ||
| set -euo pipefail | ||
| url=https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/latest-4.17/openshift-client-linux.tar.gz | ||
| if ! which oc; then | ||
| curl --fail --no-progress-meter -L "$url" | gzip -cd | sudo -- tar -x -C /usr/bin oc | ||
| fi | ||
| - name: Validate Manifests | ||
| run: hack/verify-manifests.sh |
This file contains 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 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,71 @@ | ||
| #!/bin/bash -e | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" | ||
|
|
||
| # You can ignore building manifests for some tasks by providing the SKIP_TASKS variable | ||
| # with the task name separated by a space, for example: | ||
| # SKIP_TASKS="git-clone init" | ||
|
|
||
| SKIP_TASKS="generate-odcs-compose provision-env-with-ephemeral-namespace verify-signed-rpms" | ||
|
|
||
| # You can ignore building manifests for some pipelines by providing the SKIP_PIPELINES variable | ||
| # with the task name separated by a space, for example: | ||
| # SKIP_PIPELINES="rhtap gitops-pull-request-rhtap" | ||
|
|
||
| SKIP_PIPELINES="gitops-pull-request-rhtap" | ||
|
|
||
| main() { | ||
| local dirs | ||
|
|
||
| cd "$SCRIPT_DIR/.." | ||
| local ret=0 | ||
| find task/*/*/*.yaml -maxdepth 0 | awk -F '/' '{ print $0, $2, $3, $4 }' | \ | ||
| while read -r task_path task_name task_version file_name | ||
| do | ||
| if [[ "$file_name" == "kustomization.yaml" ]]; then | ||
| echo "Building task manifest for: $task_name" | ||
| else | ||
| continue | ||
| fi | ||
| # Skip the tasks mentioned in SKIP_TASKS | ||
| skipit= | ||
| for tname in ${SKIP_TASKS};do | ||
| [[ ${tname} == "${task_name}" ]] && skipit=True | ||
| done | ||
| [[ -n ${skipit} ]] && continue | ||
| if ! oc kustomize -o "task/$task_name/$task_version/$task_name.yaml" "task/$task_name/$task_version/"; then | ||
| echo "failed to build task: $task_name" >&2 | ||
| ret=1 | ||
| fi | ||
| done | ||
|
|
||
| find pipelines/*/*.yaml -maxdepth 0 | awk -F '/' '{ print $0, $2, $3 }' | \ | ||
| while read -r pipeline_path pipeline_name file_name | ||
| do | ||
| if [[ "$file_name" == "kustomization.yaml" ]]; then | ||
| echo "Building pipeline manifest for: $pipeline_name" | ||
| else | ||
| continue | ||
| fi | ||
| # Skip the pipelines mentioned in SKIP_PIPELINES | ||
| skipit= | ||
| for pname in ${SKIP_PIPELINES};do | ||
| [[ ${pname} == "${pipeline_name}" ]] && skipit=True | ||
| done | ||
| [[ -n ${skipit} ]] && continue | ||
| if ! oc kustomize -o "pipelines/$pipeline_name/$pipeline_name.yaml" "pipelines/$pipeline_name"; then | ||
| echo "failed to build pipeline: $pipeline_name" >&2 | ||
| ret=1 | ||
| fi | ||
| done | ||
|
|
||
| exit "$ret" | ||
|
|
||
| } | ||
|
|
||
| if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then | ||
| main "$@" | ||
| fi | ||
|
|
||
|
|
||
|
|
||
This file contains 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 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,20 @@ | ||
| #!/bin/bash -e | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" | ||
|
|
||
| main() { | ||
|
|
||
| "${SCRIPT_DIR}"/build-manifests.sh | ||
| if [[ $(git status --porcelain) ]]; then | ||
| git diff --exit-code >&2 || { | ||
| echo "Did you forget to build the manifests locally?" >&2; | ||
| echo "Please run ./hack/build-manifests.sh and update your PR" >&2; | ||
| exit 1; | ||
| } | ||
| fi | ||
|
There was a problem hiding this comment. Looks like There was a problem hiding this comment. Described it in the README change here. Do you think it is sufficient or need to be added to the There was a problem hiding this comment. The content linked tells what need to do for task and pipeline authors, it is not a description to the whole solution. In my mind, the description could tell, for example, what the task and pipeline authors should do, what the maintainers should do, how the kustomized manifests are validated, whether this validation changes the build-definitions task and pipelines contribution workflow, even the build-and-push, etc. There was a problem hiding this comment. Updated the README now. We don't need to change anything on the |
||
| echo "changes are up to date" >&2 | ||
| } | ||
|
|
||
| if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then | ||
| main "$@" | ||
| fi | ||
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.
Why allowing to skip tasks and pipelines?
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.
These tasks are mirrored from another repo, there is some automation which syncs them. If we change anything manually, that will be reverted. So skipped them.