Fix the publish chart workflow (#2489)
Co-authored-by: Nikola Jokic <jokicnikola07@gmail.com>
This commit is contained in:
		
							parent
							
								
									087f20fd5d
								
							
						
					
					
						commit
						1a491cbfe5
					
				|  | @ -5,15 +5,21 @@ name: Publish Helm Chart | ||||||
| on: | on: | ||||||
|   push: |   push: | ||||||
|     branches: |     branches: | ||||||
|       - master |     - master | ||||||
|     paths: |     paths: | ||||||
|       - 'charts/**' |     - 'charts/**' | ||||||
|       - '.github/workflows/publish-chart.yaml' |     - '.github/workflows/publish-chart.yaml' | ||||||
|       - '!charts/actions-runner-controller/docs/**' |     - '!charts/actions-runner-controller/docs/**' | ||||||
|       - '!charts/gha-runner-scale-set-controller/**' |     - '!charts/gha-runner-scale-set-controller/**' | ||||||
|       - '!charts/gha-runner-scale-set/**' |     - '!charts/gha-runner-scale-set/**' | ||||||
|       - '!**.md' |     - '!**.md' | ||||||
|   workflow_dispatch: |   workflow_dispatch: | ||||||
|  |     inputs: | ||||||
|  |       force: | ||||||
|  |         description: 'Force publish even if the chart version is not bumped' | ||||||
|  |         type: boolean | ||||||
|  |         required: true | ||||||
|  |         default: false | ||||||
| 
 | 
 | ||||||
| env: | env: | ||||||
|   KUBE_SCORE_VERSION: 1.10.0 |   KUBE_SCORE_VERSION: 1.10.0 | ||||||
|  | @ -29,91 +35,86 @@ jobs: | ||||||
|     outputs: |     outputs: | ||||||
|       publish-chart: ${{ steps.publish-chart-step.outputs.publish }} |       publish-chart: ${{ steps.publish-chart-step.outputs.publish }} | ||||||
|     steps: |     steps: | ||||||
|       - name: Checkout |     - name: Checkout | ||||||
|         uses: actions/checkout@v3 |       uses: actions/checkout@v3 | ||||||
|         with: |       with: | ||||||
|           fetch-depth: 0 |         fetch-depth: 0 | ||||||
| 
 | 
 | ||||||
|       - name: Set up Helm |     - name: Set up Helm | ||||||
|         uses: azure/setup-helm@v3.4 |       uses: azure/setup-helm@v3.4 | ||||||
|         with: |       with: | ||||||
|           version: ${{ env.HELM_VERSION }} |         version: ${{ env.HELM_VERSION }} | ||||||
| 
 | 
 | ||||||
|       - name: Set up kube-score |     - name: Set up kube-score | ||||||
|         run: | |       run: | | ||||||
|           wget https://github.com/zegl/kube-score/releases/download/v${{ env.KUBE_SCORE_VERSION }}/kube-score_${{ env.KUBE_SCORE_VERSION }}_linux_amd64 -O kube-score |         wget https://github.com/zegl/kube-score/releases/download/v${{ env.KUBE_SCORE_VERSION }}/kube-score_${{ env.KUBE_SCORE_VERSION }}_linux_amd64 -O kube-score | ||||||
|           chmod 755 kube-score |         chmod 755 kube-score | ||||||
| 
 | 
 | ||||||
|       - name: Kube-score generated manifests |     - name: Kube-score generated manifests | ||||||
|         run: helm template  --values charts/.ci/values-kube-score.yaml charts/* | ./kube-score score - |       run: helm template  --values charts/.ci/values-kube-score.yaml charts/* | ./kube-score score - --ignore-test pod-networkpolicy --ignore-test deployment-has-poddisruptionbudget --ignore-test deployment-has-host-podantiaffinity --ignore-test container-security-context --ignore-test pod-probes --ignore-test container-image-tag --enable-optional-test container-security-context-privileged --enable-optional-test container-security-context-readonlyrootfilesystem | ||||||
|               --ignore-test pod-networkpolicy |  | ||||||
|               --ignore-test deployment-has-poddisruptionbudget |  | ||||||
|               --ignore-test deployment-has-host-podantiaffinity |  | ||||||
|               --ignore-test container-security-context |  | ||||||
|               --ignore-test pod-probes |  | ||||||
|               --ignore-test container-image-tag |  | ||||||
|               --enable-optional-test container-security-context-privileged |  | ||||||
|               --enable-optional-test container-security-context-readonlyrootfilesystem |  | ||||||
| 
 | 
 | ||||||
|       # python is a requirement for the chart-testing action below (supports yamllint among other tests) |     # python is a requirement for the chart-testing action below (supports yamllint among other tests) | ||||||
|       - uses: actions/setup-python@v4 |     - uses: actions/setup-python@v4 | ||||||
|         with: |       with: | ||||||
|           python-version: '3.7' |         python-version: '3.11' | ||||||
| 
 | 
 | ||||||
|       - name: Set up chart-testing |     - name: Set up chart-testing | ||||||
|         uses: helm/chart-testing-action@v2.3.1 |       uses: helm/chart-testing-action@v2.3.1 | ||||||
| 
 | 
 | ||||||
|       - name: Run chart-testing (list-changed) |     - name: Run chart-testing (list-changed) | ||||||
|         id: list-changed |       id: list-changed | ||||||
|         run: | |       run: | | ||||||
|           changed=$(ct list-changed --config charts/.ci/ct-config.yaml) |         changed=$(ct list-changed --config charts/.ci/ct-config.yaml) | ||||||
|           if [[ -n "$changed" ]]; then |         if [[ -n "$changed" ]]; then | ||||||
|             echo "::set-output name=changed::true" |           echo "::set-output name=changed::true" | ||||||
|           fi |         fi | ||||||
| 
 | 
 | ||||||
|       - name: Run chart-testing (lint) |     - name: Run chart-testing (lint) | ||||||
|         run: | |       run: | | ||||||
|           ct lint --config charts/.ci/ct-config.yaml |         ct lint --config charts/.ci/ct-config.yaml | ||||||
| 
 | 
 | ||||||
|       - name: Create kind cluster |     - name: Create kind cluster | ||||||
|         if: steps.list-changed.outputs.changed == 'true' |       if: steps.list-changed.outputs.changed == 'true' | ||||||
|         uses: helm/kind-action@v1.4.0 |       uses: helm/kind-action@v1.4.0 | ||||||
| 
 | 
 | ||||||
|       # We need cert-manager already installed in the cluster because we assume the CRDs exist |     # We need cert-manager already installed in the cluster because we assume the CRDs exist | ||||||
|       - name: Install cert-manager |     - name: Install cert-manager | ||||||
|         if: steps.list-changed.outputs.changed == 'true'       |       if: steps.list-changed.outputs.changed == 'true' | ||||||
|         run: | |       run: | | ||||||
|           helm repo add jetstack https://charts.jetstack.io --force-update |         helm repo add jetstack https://charts.jetstack.io --force-update | ||||||
|           helm install cert-manager jetstack/cert-manager --set installCRDs=true --wait |         helm install cert-manager jetstack/cert-manager --set installCRDs=true --wait | ||||||
| 
 | 
 | ||||||
|       - name: Run chart-testing (install) |     - name: Run chart-testing (install) | ||||||
|         if: steps.list-changed.outputs.changed == 'true' |       if: steps.list-changed.outputs.changed == 'true' | ||||||
|         run: ct install --config charts/.ci/ct-config.yaml |       run: ct install --config charts/.ci/ct-config.yaml | ||||||
| 
 | 
 | ||||||
|       # WARNING: This relies on the latest release being at the top of the JSON from GitHub and a clean chart.yaml |     # WARNING: This relies on the latest release being at the top of the JSON from GitHub and a clean chart.yaml | ||||||
|       - name: Check if Chart Publish is Needed |     - name: Check if Chart Publish is Needed | ||||||
|         id: publish-chart-step |       id: publish-chart-step | ||||||
|         run: | |       run: | | ||||||
|           CHART_TEXT=$(curl -fs https://raw.githubusercontent.com/${{ github.repository }}/master/charts/actions-runner-controller/Chart.yaml) |         CHART_TEXT=$(curl -fs https://raw.githubusercontent.com/${{ github.repository }}/master/charts/actions-runner-controller/Chart.yaml) | ||||||
|           NEW_CHART_VERSION=$(echo "$CHART_TEXT" | grep version: | cut -d ' ' -f 2) |         NEW_CHART_VERSION=$(echo "$CHART_TEXT" | grep version: | cut -d ' ' -f 2) | ||||||
|           RELEASE_LIST=$(curl -fs https://api.github.com/repos/${{ github.repository }}/releases  | jq .[].tag_name | grep actions-runner-controller | cut -d '"' -f 2 | cut -d '-' -f 4) |         RELEASE_LIST=$(curl -fs https://api.github.com/repos/${{ github.repository }}/releases  | jq .[].tag_name | grep actions-runner-controller | cut -d '"' -f 2 | cut -d '-' -f 4) | ||||||
|           LATEST_RELEASED_CHART_VERSION=$(echo $RELEASE_LIST | cut -d ' ' -f 1) |         LATEST_RELEASED_CHART_VERSION=$(echo $RELEASE_LIST | cut -d ' ' -f 1) | ||||||
|           echo "CHART_VERSION_IN_MASTER=$NEW_CHART_VERSION" >> $GITHUB_ENV |  | ||||||
|           echo "LATEST_CHART_VERSION=$LATEST_RELEASED_CHART_VERSION" >> $GITHUB_ENV |  | ||||||
|           if [[ $NEW_CHART_VERSION != $LATEST_RELEASED_CHART_VERSION ]]; then |  | ||||||
|             echo "publish=true" >> $GITHUB_OUTPUT |  | ||||||
|           else |  | ||||||
|             echo "publish=false" >> $GITHUB_OUTPUT |  | ||||||
|           fi |  | ||||||
| 
 | 
 | ||||||
|       - name: Job summary |         echo "CHART_VERSION_IN_MASTER=$NEW_CHART_VERSION" >> $GITHUB_ENV | ||||||
|         run: | |         echo "LATEST_CHART_VERSION=$LATEST_RELEASED_CHART_VERSION" >> $GITHUB_ENV | ||||||
|           echo "Chart linting has been completed." >> $GITHUB_STEP_SUMMARY | 
 | ||||||
|           echo "" >> $GITHUB_STEP_SUMMARY |         # Always publish if force is true | ||||||
|           echo "**Status:**" >> $GITHUB_STEP_SUMMARY |         if [[ $NEW_CHART_VERSION != $LATEST_RELEASED_CHART_VERSION || "${{ inputs.force }}" == "true" ]]; then | ||||||
|           echo "- chart version in master: ${{ env.CHART_VERSION_IN_MASTER }}" >> $GITHUB_STEP_SUMMARY |           echo "publish=true" >> $GITHUB_OUTPUT | ||||||
|           echo "- latest chart version: ${{ env.LATEST_CHART_VERSION }}" >> $GITHUB_STEP_SUMMARY |         else | ||||||
|           echo "- publish new chart: ${{ steps.publish-chart-step.outputs.publish }}" >> $GITHUB_STEP_SUMMARY |           echo "publish=false" >> $GITHUB_OUTPUT | ||||||
|  |         fi | ||||||
|  | 
 | ||||||
|  |     - name: Job summary | ||||||
|  |       run: | | ||||||
|  |         echo "Chart linting has been completed." >> $GITHUB_STEP_SUMMARY | ||||||
|  |         echo "" >> $GITHUB_STEP_SUMMARY | ||||||
|  |         echo "**Status:**" >> $GITHUB_STEP_SUMMARY | ||||||
|  |         echo "- chart version in master: ${{ env.CHART_VERSION_IN_MASTER }}" >> $GITHUB_STEP_SUMMARY | ||||||
|  |         echo "- latest chart version: ${{ env.LATEST_CHART_VERSION }}" >> $GITHUB_STEP_SUMMARY | ||||||
|  |         echo "- publish new chart: ${{ steps.publish-chart-step.outputs.publish }}" >> $GITHUB_STEP_SUMMARY | ||||||
| 
 | 
 | ||||||
|   publish-chart: |   publish-chart: | ||||||
|     if: needs.lint-chart.outputs.publish-chart == 'true' |     if: needs.lint-chart.outputs.publish-chart == 'true' | ||||||
|  | @ -121,105 +122,86 @@ jobs: | ||||||
|     name: Publish Chart |     name: Publish Chart | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
|     permissions: |     permissions: | ||||||
|       contents: write  # for helm/chart-releaser-action to push chart release and create a release |       contents: write # for helm/chart-releaser-action to push chart release and create a release | ||||||
|     env: |     env: | ||||||
|       CHART_TARGET_ORG: actions-runner-controller |       CHART_TARGET_ORG: actions-runner-controller | ||||||
|       CHART_TARGET_REPO: actions-runner-controller.github.io |       CHART_TARGET_REPO: actions-runner-controller.github.io | ||||||
|       CHART_TARGET_BRANCH: master |       CHART_TARGET_BRANCH: master | ||||||
| 
 | 
 | ||||||
|     steps: |     steps: | ||||||
|       - name: Checkout |     - name: Checkout | ||||||
|         uses: actions/checkout@v3 |       uses: actions/checkout@v3 | ||||||
|         with: |       with: | ||||||
|           fetch-depth: 0 |         fetch-depth: 0 | ||||||
| 
 | 
 | ||||||
|       - name: Configure Git |     - name: Configure Git | ||||||
|         run: | |       run: | | ||||||
|           git config user.name "$GITHUB_ACTOR" |         git config user.name "$GITHUB_ACTOR" | ||||||
|           git config user.email "$GITHUB_ACTOR@users.noreply.github.com" |         git config user.email "$GITHUB_ACTOR@users.noreply.github.com" | ||||||
| 
 | 
 | ||||||
|       - name: Get Token |     - name: Get Token | ||||||
|         id: get_workflow_token |       id: get_workflow_token | ||||||
|         uses: peter-murray/workflow-application-token-action@8e1ba3bf1619726336414f1014e37f17fbadf1db |       uses: peter-murray/workflow-application-token-action@8e1ba3bf1619726336414f1014e37f17fbadf1db | ||||||
|         with: |       with: | ||||||
|           application_id: ${{ secrets.ACTIONS_ACCESS_APP_ID }} |         application_id: ${{ secrets.ACTIONS_ACCESS_APP_ID }} | ||||||
|           application_private_key: ${{ secrets.ACTIONS_ACCESS_PK }} |         application_private_key: ${{ secrets.ACTIONS_ACCESS_PK }} | ||||||
|           organization: ${{ env.CHART_TARGET_ORG }} |         organization: ${{ env.CHART_TARGET_ORG }} | ||||||
| 
 | 
 | ||||||
|       - name: Install chart-releaser |     - name: Install chart-releaser | ||||||
|         uses: helm/chart-releaser-action@v1.4.1 |       uses: helm/chart-releaser-action@v1.4.1 | ||||||
|         with: |       with: | ||||||
|           install_only: true |         install_only: true | ||||||
|           install_dir: ${{ github.workspace }}/bin |         install_dir: ${{ github.workspace }}/bin | ||||||
| 
 | 
 | ||||||
|       - name: Package and upload release assets |     - name: Package and upload release assets | ||||||
|         run: | |       run: | | ||||||
|           cr package \ |         cr package \ | ||||||
|             ${{ github.workspace }}/charts/actions-runner-controller/ \ |           ${{ github.workspace }}/charts/actions-runner-controller/ \ | ||||||
|             --package-path .cr-release-packages |           --package-path .cr-release-packages | ||||||
| 
 | 
 | ||||||
|           cr upload \ |         cr upload \ | ||||||
|             --owner "$(echo ${{ github.repository }} | cut -d '/' -f 1)" \ |           --owner "$(echo ${{ github.repository }} | cut -d '/' -f 1)" \ | ||||||
|             --git-repo "$(echo ${{ github.repository }} | cut -d '/' -f 2)" \ |           --git-repo "$(echo ${{ github.repository }} | cut -d '/' -f 2)" \ | ||||||
|             --package-path .cr-release-packages \ |           --package-path .cr-release-packages \ | ||||||
|             --token ${{ secrets.GITHUB_TOKEN }} |           --token ${{ secrets.GITHUB_TOKEN }} | ||||||
| 
 | 
 | ||||||
|       - name: Generate updated index.yaml |     - name: Generate updated index.yaml | ||||||
|         run: | |       run: | | ||||||
|           cr index \ |         cr index \ | ||||||
|             --owner "$(echo ${{ github.repository }} | cut -d '/' -f 1)" \ |           --owner "$(echo ${{ github.repository }} | cut -d '/' -f 1)" \ | ||||||
|             --git-repo "$(echo ${{ github.repository }} | cut -d '/' -f 2)" \ |           --git-repo "$(echo ${{ github.repository }} | cut -d '/' -f 2)" \ | ||||||
|             --index-path ${{ github.workspace }}/index.yaml \ |           --index-path ${{ github.workspace }}/index.yaml \ | ||||||
|             --pages-branch 'gh-pages' \ |           --push \ | ||||||
|             --pages-index-path 'index.yaml' |           --pages-branch 'gh-pages' \ | ||||||
|  |           --pages-index-path 'index.yaml' | ||||||
| 
 | 
 | ||||||
|       # This step is required to not throw away changes made to the index.yaml on every new chart release. |     # Chart Release was never intended to publish to a different repo | ||||||
|       # |     # this workaround is intended to move the index.yaml to the target repo | ||||||
|       # We update the index.yaml in the actions-runner-controller.github.io repo |     # where the github pages are hosted | ||||||
|       # by appending the new chart version to the index.yaml saved in actions-runner-controller repo |     - name: Checkout target repository | ||||||
|       # and copying and commiting the updated index.yaml to the github.io one. |       uses: actions/checkout@v3 | ||||||
|       # See below for more context: |       with: | ||||||
|       # - https://github.com/actions-runner-controller/actions-runner-controller.github.io/pull/2 |         repository: ${{ env.CHART_TARGET_ORG }}/${{ env.CHART_TARGET_REPO }} | ||||||
|       # - https://github.com/actions/actions-runner-controller/pull/2452 |         path: ${{ env.CHART_TARGET_REPO }} | ||||||
|       - name: Commit and push to actions/actions-runner-controller |         ref: ${{ env.CHART_TARGET_BRANCH }} | ||||||
|         run: | |         token: ${{ steps.get_workflow_token.outputs.token }} | ||||||
|           git stash |  | ||||||
|           git checkout gh-pages |  | ||||||
|           git stash pop |  | ||||||
|           git config user.name "$GITHUB_ACTOR" |  | ||||||
|           git config user.email "$GITHUB_ACTOR@users.noreply.github.com" |  | ||||||
|           git add . |  | ||||||
|           git commit -m "Update index.yaml" |  | ||||||
|           git push |  | ||||||
|         working-directory: ${{ github.workspace }} |  | ||||||
| 
 | 
 | ||||||
|       # Chart Release was never intended to publish to a different repo |     - name: Copy index.yaml | ||||||
|       # this workaround is intended to move the index.yaml to the target repo |       run: | | ||||||
|       # where the github pages are hosted |         cp ${{ github.workspace }}/index.yaml ${{ env.CHART_TARGET_REPO }}/actions-runner-controller/index.yaml | ||||||
|       - name: Checkout target repository |  | ||||||
|         uses: actions/checkout@v3 |  | ||||||
|         with: |  | ||||||
|           repository: ${{ env.CHART_TARGET_ORG }}/${{ env.CHART_TARGET_REPO }} |  | ||||||
|           path: ${{ env.CHART_TARGET_REPO }} |  | ||||||
|           ref: ${{ env.CHART_TARGET_BRANCH }} |  | ||||||
|           token: ${{ steps.get_workflow_token.outputs.token }} |  | ||||||
| 
 | 
 | ||||||
|       - name: Copy index.yaml |     - name: Commit and push to target repository | ||||||
|         run: | |       run: | | ||||||
|           cp ${{ github.workspace }}/index.yaml ${{ env.CHART_TARGET_REPO }}/actions-runner-controller/index.yaml |         git config user.name "$GITHUB_ACTOR" | ||||||
|  |         git config user.email "$GITHUB_ACTOR@users.noreply.github.com" | ||||||
|  |         git add . | ||||||
|  |         git commit -m "Update index.yaml" | ||||||
|  |         git push | ||||||
|  |       working-directory: ${{ github.workspace }}/${{ env.CHART_TARGET_REPO }} | ||||||
| 
 | 
 | ||||||
|       - name: Commit and push to target repository |     - name: Job summary | ||||||
|         run: | |       run: | | ||||||
|           git config user.name "$GITHUB_ACTOR" |         echo "New helm chart has been published" >> $GITHUB_STEP_SUMMARY | ||||||
|           git config user.email "$GITHUB_ACTOR@users.noreply.github.com" |         echo "" >> $GITHUB_STEP_SUMMARY | ||||||
|           git add . |         echo "**Status:**" >> $GITHUB_STEP_SUMMARY | ||||||
|           git commit -m "Update index.yaml" |         echo "- New [index.yaml](https://github.com/${{ env.CHART_TARGET_ORG }}/${{ env.CHART_TARGET_REPO }}/tree/main/actions-runner-controller) pushed" >> $GITHUB_STEP_SUMMARY | ||||||
|           git push |  | ||||||
|         working-directory: ${{ github.workspace }}/${{ env.CHART_TARGET_REPO }} |  | ||||||
| 
 |  | ||||||
|       - name: Job summary |  | ||||||
|         run: | |  | ||||||
|           echo "New helm chart has been published" >> $GITHUB_STEP_SUMMARY |  | ||||||
|           echo "" >> $GITHUB_STEP_SUMMARY |  | ||||||
|           echo "**Status:**" >> $GITHUB_STEP_SUMMARY |  | ||||||
|           echo "- New [index.yaml](https://github.com/${{ env.CHART_TARGET_ORG }}/${{ env.CHART_TARGET_REPO }}/tree/main/actions-runner-controller) pushed" >> $GITHUB_STEP_SUMMARY |  | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue