CI: Update to use Github App (#516) (#520)

freifunkMUC · Dec 2, 2024 · 45be751 · 45be751
1 parent 2429216
commit 45be751
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 20 deletions.
diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml
@@ -4,21 +4,28 @@ name: Backport merged pull request
 on:  # yamllint disable-line rule:truthy
   pull_request_target:
     types: [closed, labeled]
-permissions:
-  contents: write # so it can comment
-  pull-requests: write # so it can create pull requests
-  actions: write # so it can create pull requests on actions/workflows
+
 jobs:
   backport:
     name: Backport pull request
     runs-on: ubuntu-latest
     # Don't run on closed unmerged pull requests
     if: github.event.pull_request.merged
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - name: Clone Firmware
+        uses: actions/checkout@v4 # v4
+
+      - name: Get Github App Token
+        uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0
+        id: app-token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.PRIVATE_KEY }}
+
       - name: Create backport pull requests
         uses: korthout/backport-action@be567af183754f6a5d831ae90f648954763f17f5 # v3.1.0
         with:
+          github_token: ${{ steps.app-token.outputs.token }}
           experimental: >
             {
               "conflict_resolution": "draft_commit_conflicts"

diff --git a/.github/workflows/bump-modules.yml b/.github/workflows/bump-modules.yml
@@ -4,23 +4,32 @@ name: "Update Modules base"
 on:
   workflow_dispatch:
 
-permissions:
-  contents: write # so it can comment
-  pull-requests: write # so it can create pull requests
-
 jobs:
   update-Modules:
     runs-on: ubuntu-22.04
-    env:
-      COMMIT_NAME: github-actions[bot] 
-      COMMIT_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
     steps:
       - name: Clone Firmware
-        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        uses: actions/checkout@v4 # v4
+
+      - name: Get Github App Token
+        uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0
+        id: app-token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.PRIVATE_KEY }}
+
+      - name: Get GitHub App User ID
+        id: get-user-id
+        run: echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
 
       - name: Configure Git User and E-Mail
         run: git config --global user.name "${{ env.COMMIT_NAME }}" && git config --global user.email "${{ env.COMMIT_EMAIL }}"
-
+        env:
+          COMMIT_NAME:  ${{ steps.app-token.outputs.app-slug }}[bot] 
+          COMMIT_EMAIL: ${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com
+
       - name: Get update branch name
         id: branch-name
         run: echo "branch-name=update-modules-${{ github.ref_name }}-$(date +%s)" >> $GITHUB_OUTPUT
@@ -32,6 +41,7 @@ jobs:
         id: cpr
         uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
         with:
+          token: ${{ steps.app-token.outputs.token }}
           title: '[${{ github.ref_name }}] update modules'
           body: |
             Update modules for ${{ github.ref_name }} branch

diff --git a/.github/workflows/firmware.yml b/.github/workflows/firmware.yml
@@ -1,3 +1,4 @@
+---
 name: Build ffmuc firmware
 
 on:
@@ -26,7 +27,7 @@ jobs:
       build_target_json: ${{ steps.set_target.outputs.build_target }}
     steps:
       - name: Checkout
-        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        uses: actions/checkout@v4 # v4
       - name: Set target matrix
         id: set_target
         shell: bash
@@ -48,7 +49,7 @@ jobs:
           sudo rm -rf /usr/local/lib/android
           sudo rm -rf /opt/ghc
       - name: Checkout
-        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        uses: actions/checkout@v4 # v4
         with:
           fetch-depth: 0
       - name: Install build dependencies

diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
@@ -18,7 +18,8 @@ jobs:
     name: runner / shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Clone Firmware
+        uses: actions/checkout@v4 # v4
       - name: shellcheck
         # Make sure the action is pinned to a commit, as all reviewdog repos
         # have hundreds of contributors with write access (breaks easy/often)

diff --git a/.github/workflows/update-targets.yml b/.github/workflows/update-targets.yml
@@ -19,7 +19,21 @@ jobs:
   update-Modules:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Clone Firmware
+        uses: actions/checkout@v4 # v4
+
+      - name: Get Github App Token
+        uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0
+        id: app-token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.PRIVATE_KEY }}
+
+      - name: Get GitHub App User ID
+        id: get-user-id
+        run: echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
 
       - name: Get update branch name
         id: branch-name
@@ -36,14 +50,14 @@ jobs:
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
         with:
+          token: ${{ steps.app-token.outputs.token }}
           title: '[${{ github.ref_name }}] Add targets ${{ steps.new-targets.outputs.names }}'
           body: |
             Updated targets for branch ${{ github.ref_name }}
 
             New targets: `${{ steps.new-targets.outputs.names }}`
-
-            ⚠️ Please trigger the CI before merging this pull request. ⚠️
           commit-message: "targets: add ${{ steps.new-targets.outputs.names }}"
+          committer: ${{ steps.app-token.outputs.app-slug }}[bot] <${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com>
           branch: ${{ steps.branch-name.outputs.branch-name }}
           labels: ${{ github.ref_name }}
           draft: true # this step does not trigger a CI run, so always mark them as draft