feat: Add GitHub Action for Dockerfile release update and slack notif…

…ication (#38) * first commit, added workflow for check release * test check release * test check release * test check release * test check release with changelog * test with some fix * test with some fix 2 * test with some fix 3 * test with some fix 4 * test with some fix 5 * test with some fix 6 * test with some fix 7 * test minor * test new dockerfile change * test new dockerfile change 2 * test new dockerfile change 3 * test new dockerfile change 4 * test new dockerfile change 5 * test new dockerfile change 6 * test new dockerfile change 7 * test new dockerfile change 8 * test new dockerfile change 9 * test new dockerfile change 10 * test new dockerfile change 11 * test new dockerfile change 12 * test new dockerfile change 13 * test new dockerfile change 14 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 15 * test new dockerfile change 16 * test new dockerfile change 17 * test new dockerfile change 17 * test new dockerfile change 18 * test new dockerfile change 19 * test new dockerfile change 19 * test new dockerfile change 19 * test branch creation * test branch creation 2 * test branch creation 3 * test branch creation 4 * test slack notification * test slack notification and new branch version * test slack notification * test branch creation * test sha * test sha arch * fixed form and sha * added new PR action end gitignore update * removed on push trigger * minor * minor * edit actions/github-script to use sha * replaced PR creation with git commands * fixed branch exist check * test GH commands for variables * added new slack action * edit action name * test token * test token * re enabled branch creation, PR and slack notification * removed release.json * removed duplicate env, updated ubuntu ref and added environment * test env variable set * restore * branch exist var fixed * fix: re added release.json check - test no file * fix: re added release.json check - test 2 no file * fix: re added release.json check - test branch exist * fix: re added release.json check - test file exist not updated * fix: re added release.json check - test file exist updated * fix: removed env configuration and GH PAT secret call * fix: minor * fix: Update Dockerfile to latest * fix: removed old vars
pagopa · Aug 1, 2024 · e75a0c2 · e75a0c2
1 parent b585052
commit e75a0c2
Show file tree

Hide file tree

Showing 5 changed files with 210 additions and 1 deletion.
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -0,0 +1,202 @@
+name: Check Release and Update Dockerfile
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 9 * * *' # Execute everyday at 9 AM
+
+jobs:
+  check-release:
+    runs-on: ubuntu-22.04
+    environment: prod
+    permissions:
+      id-token: write
+      contents: write
+      pull-requests: write
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        name: Checkout
+
+      - name: Get latest release from another repo
+        id: get_release
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          script: |
+            const latestRelease = await github.rest.repos.getLatestRelease({
+              owner: 'actions',
+              repo: 'runner'
+            });
+            const releaseInfo = {
+              tag_name: latestRelease.data.tag_name,
+              sha: latestRelease.data.target_commitish,
+            };
+            console.log(JSON.stringify(releaseInfo));
+            return JSON.stringify(releaseInfo);
+      
+      - name: Define release outputs
+        id: release_outputs
+        run: |
+          release_info="${{ steps.get_release.outputs.result }}"  
+          tag_name=$(echo "$release_info" | jq -r '.tag_name')
+          sha=$(echo "$release_info" | jq -r '.sha')
+          short_tag_name=$(echo "$tag_name" | sed 's/^v//')
+
+          echo "tag_name=$tag_name" >> "$GITHUB_OUTPUT"
+          echo "sha=$sha" >> "$GITHUB_OUTPUT"
+          echo "short_tag_name=$short_tag_name" >> "$GITHUB_OUTPUT"
+      
+      # Check if the release has changed
+      # if release.json file exist and the current tag and sha are the same as the latest release, then no changes have been made
+      # if release.json file does not exist or exist but the current tag and sha are different, then the release will be considered as changed
+
+      - name: Check if release has changed
+        id: check_release_changes
+        run: |
+          new_tag=${{ steps.release_outputs.outputs.tag_name }}
+          new_sha=${{ steps.release_outputs.outputs.sha }}
+          
+          if [ -f release.json ]; then
+            current_tag=$(jq -r '.current_tag' release.json)
+            current_sha=$(jq -r '.current_sha' release.json)
+
+            if [[ "$current_tag" == "$new_tag" && "$current_sha" == "$new_sha" ]]; then
+              echo "No changes in release."
+              echo "release_changed=false" >> "$GITHUB_OUTPUT"
+            else
+              echo "Release has changed."
+              echo "release_changed=true" >> "$GITHUB_OUTPUT"
+
+              # Update release.json
+              jq -n --arg new_tag "$new_tag" --arg new_sha "$new_sha" \
+                '{current_tag: $new_tag, current_sha: $new_sha}' > release.json
+              cat release.json
+            fi
+          else
+            echo "Release is changed, file release.json does not exist."
+            echo "release_changed=true" >> "$GITHUB_OUTPUT"
+
+            # Create release.json
+            jq -n --arg new_tag "$new_tag" --arg new_sha "$new_sha" \
+              '{current_tag: $new_tag, current_sha: $new_sha}' > release.json
+
+            cat release.json
+          fi
+          
+      # Retrieve the SHA of the latest release for the linux/amd64 architecture.
+      # To accomplish this, we fetch all versions and identify the 5th version, which corresponds to the latest release with that specific architecture.
+      # Reference: https://docs.github.com/en/rest/packages/packages?apiVersion=2022-11-28#list-package-versions-for-a-package-owned-by-an-organization
+      ## NOTE: The SHA obtained in this step differs from the previous one, as it represents the branch commit SHA used for change verification.
+
+      - name: Get Docker image digests
+        if: steps.check_release_changes.outputs.release_changed == 'true'
+        id: get_digests
+        run: |
+          digests=$(gh api -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" /orgs/actions/packages/container/actions-runner/versions)
+          latest_digest=$(echo "$digests" | jq -r '.[] | select(.metadata.container.tags | index("latest")) | .name')
+          echo $latest_digest
+          echo "arch_sha_name=$latest_digest" >> "$GITHUB_OUTPUT"
+
+      - name: Get changelog file
+        id: changelog
+        run: |
+          if [ ! -f CHANGELOG.md ]; then
+            echo "Changelog file does not exist. Creating one..."
+            touch CHANGELOG.md
+          fi
+
+      - name: Update Changelog
+        if: steps.check_release_changes.outputs.release_changed == 'true'
+        id: update_changelog
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          script: |
+            const fs = require('fs');
+            const changelogPath = 'CHANGELOG.md';
+            const dockerImage = `docker pull ghcr.io/actions/runner:${{ steps.release_outputs.outputs.tag_name }}@${{ steps.get_digests.outputs.arch_sha_name }}`;
+  
+            const changelogEntry = `## ${{ steps.release_outputs.outputs.tag_name }}\n- Docker Image: \`${dockerImage}\`\n`;
+
+            const changelogContent = fs.readFileSync(changelogPath, 'utf8');
+            fs.writeFileSync(changelogPath, `${changelogEntry}\n${changelogContent}`);
+
+      - name: Update Dockerfile
+        if: steps.check_release_changes.outputs.release_changed == 'true'
+        id: update_dockerfile
+        run: |
+          echo "Updating Dockerfile..."
+          
+          # Construct the new FROM statement
+          new_from="FROM ghcr.io/actions/actions-runner:${{ steps.release_outputs.outputs.short_tag_name }}@${{ steps.get_digests.outputs.arch_sha_name }} AS base"
+          
+          # Replace the first line with the new FROM statement
+          sed -i "1s|.*|$new_from|" Dockerfile
+
+          echo "Dockerfile updated."
+  
+      - name: Set up Git
+        if: steps.check_release_changes.outputs.release_changed == 'true'
+        id: git_setup
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Action"
+
+          echo "branch_name=update-release-to-${{ steps.release_outputs.outputs.tag_name }}" >> $GITHUB_OUTPUT
+
+      - name: Create branch
+        if: steps.check_release_changes.outputs.release_changed == 'true'
+        id: create_branch
+        run: |
+          if git ls-remote --exit-code --heads origin  ${{ steps.git_setup.outputs.branch_name }}; then
+            echo "Branch ${{ steps.git_setup.outputs.branch_name }} already exists"
+            echo "branch_exist=true" >> "$GITHUB_OUTPUT"
+          else
+            git checkout -b ${{ steps.git_setup.outputs.branch_name }}
+            git add release.json
+            git add Dockerfile
+            git add CHANGELOG.md
+            git commit -m "Update release to ${{ steps.release_outputs.outputs.tag_name }}"
+            git push origin ${{ steps.git_setup.outputs.branch_name }}
+            echo "branch_exist=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Create PR
+        if: ${{ steps.check_release_changes.outputs.release_changed == 'true' && steps.create_branch.outputs.branch_exist == 'false' }}
+        run: |
+          gh pr create --title 'fix: Update Dockerfile image Release to ${{ steps.release_outputs.outputs.tag_name }}' --body 'Update Dockerfile image release to ${{ steps.release_outputs.outputs.tag_name }} with sha ${{ steps.get_digests.outputs.arch_sha_name }}' --base main --head ${{ steps.git_setup.outputs.branch_name }}
+
+      - name: Slack Notification
+        if: ${{ always() && (env.SLACK_WEBHOOK_URL) && steps.check_release_changes.outputs.release_changed == 'true' }}
+        uses: slackapi/slack-github-action@70cd7be8e40a46e8b0eced40b0de447bdb42f68e #v1.26.0
+        with:
+          payload: |
+            {
+              "text":"${{ job.status }}",
+              "blocks":[
+                {
+                    "type":"section",
+                    "text":{
+                      "type":"mrkdwn",
+                      "text":":white_check_mark: New Release identified [${{ steps.release_outputs.outputs.tag_name }}]"
+                    }
+                },
+                {
+                    "type":"section",
+                    "text":{
+                      "type":"mrkdwn",
+                      "text":"*Check for New Release and Update Dockerfile* - Release:\n - Tag: ${{ steps.release_outputs.outputs.tag_name }}\n - Branch SHA: ${{ steps.release_outputs.outputs.sha }}\n - Release URL: https://github.com/actions/runner/releases/tag/${{ steps.release_outputs.outputs.tag_name }}\n"
+                    }
+                },
+                {
+                    "type":"section",
+                    "text":{
+                      "type":"mrkdwn",
+                      "text":"*Linked Repo*: <https://github.com/${{github.repository}}|${{github.repository}}>\n"
+                    }
+                }
+              ]
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 .tmp
+.secrets
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,2 @@
+## v2.318.0
+- Docker Image: `docker pull ghcr.io/actions/runner:v2.318.0@sha256:b05be064f0b30ac9d1ec0526f9429f7df2da45379b0cf50f1fda97793e1bd416`
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM ghcr.io/actions/actions-runner:2.317.0@sha256:95db6fbb020b9f734e8a00389291dae766f0e6ad3d1171ae2d68e9ad8ac4a985 AS base
+FROM ghcr.io/actions/actions-runner:2.318.0@sha256:b05be064f0b30ac9d1ec0526f9429f7df2da45379b0cf50f1fda97793e1bd416 AS base
 
 USER root
 

diff --git a/release.json b/release.json
@@ -0,0 +1,4 @@
+{
+  "current_tag": "v2.318.0",
+  "current_sha": "5e57957c98c80bcdcc357fd42472349826cd76ad"
+}