update: release/2.2.1 to develop

.github/workflows/gitflow.yml

@@ -56,6 +56,15 @@ on:
       TOKEN:
         description: 'GitHub token (Default: GitHub Action token)'
         required: false
+      GITHUB_APP_ID:
+        description: 'GitHub app id for fetching GitHub token'
+        required: false
+      GITHUB_APP_PRIVATE_KEY:
+        description: 'GitHub app private key for fetching GitHub token'
+        required: false
+      GITHUB_APP_OWNER:
+        description: 'GitHub app owner for fetching GitHub token'
+        required: false
 
 env:
   MAIN_BRANCH: ${{ inputs.MAIN_BRANCH || 'main' }}
@@ -66,7 +75,10 @@ env:
   VERSION_EXPRESSION: ${{ inputs.VERSION_EXPRESSION || '[0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*' }}
   VERSION_HEADER: ${{ inputs.VERSION_HEADER || '## ' }}
   CHANGELOG: ${{ inputs.CHANGELOG || 'changelog.md' }}
-  GITHUB_TOKEN: ${{ secrets.TOKEN || github.token }}
+  TOKEN: ${{ secrets.TOKEN || github.token }}
+  GITHUB_APP_ID: ${{ secrets.GITHUB_APP_ID }}
+  GITHUB_APP_PRIVATE_KEY: ${{ secrets.GITHUB_APP_PRIVATE_KEY }}
+  GITHUB_APP_OWNER: ${{ secrets.GITHUB_APP_OWNER }}
   SOURCE_BRANCH: ${{ github.event.pull_request.head.ref }}
   SOURCE_COMMIT: ${{ github.event.pull_request.head.sha }}
   DESTINATION_BRANCH: ${{ github.event.pull_request.base.ref }}
@@ -76,6 +88,21 @@ jobs:
   gitflow:
     runs-on: ubuntu-latest
     steps:
+      - name: Fetching GitHub Token
+        id: fetching-github-token
+        if: ${{ env.GITHUB_APP_ID && env.GITHUB_APP_PRIVATE_KEY && env.GITHUB_APP_OWNER }}
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ env.GITHUB_APP_ID }}
+          private-key: ${{ env.GITHUB_APP_PRIVATE_KEY }}
+          owner: ${{ env.GITHUB_APP_OWNER }}
+
+      - name: Using GitHub Token
+        if: ${{ env.GITHUB_APP_ID && env.GITHUB_APP_PRIVATE_KEY && env.GITHUB_APP_OWNER }}
+        run: |
+          echo '::add-mask::${{ steps.fetching-github-token.outputs.token }}'
+          echo 'TOKEN=${{ steps.fetching-github-token.outputs.token }}' >> $GITHUB_ENV
+
       - name: Check branch
         id: check-branch
         run: |
@@ -155,12 +182,12 @@ jobs:
               pull_number: context.issue.number,
               state: 'closed',
             })
-          github-token: ${{ env.GITHUB_TOKEN }}
+          github-token: ${{ env.TOKEN }}
 
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          token: ${{ env.GITHUB_TOKEN }}
+          token: ${{ env.TOKEN }}
 
       - name: Checkout commit
         run: |
@@ -207,7 +234,7 @@ jobs:
               pull_number: context.issue.number,
               state: 'closed',
             })
-          github-token: ${{ env.GITHUB_TOKEN }}
+          github-token: ${{ env.TOKEN }}
 
       - name: If warn on check feature branch
         if: always() && steps.check-feature-branch.outputs.warning != null
@@ -234,7 +261,7 @@ jobs:
               repo: context.repo.repo,
               body: message,
             })
-          github-token: ${{ env.GITHUB_TOKEN }}
+          github-token: ${{ env.TOKEN }}
 
       - name: Check release branch
         id: check-release-branch
@@ -306,7 +333,7 @@ jobs:
               pull_number: context.issue.number,
               state: 'closed',
             })
-          github-token: ${{ env.GITHUB_TOKEN }}
+          github-token: ${{ env.TOKEN }}
 
       - name: Finish feature branch
         id: finish-feature-branch
@@ -361,7 +388,7 @@ jobs:
             && git push origin --delete ${{ env.SOURCE_BRANCH }} \
             || :
         env:
-          GH_TOKEN: ${{ env.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ env.TOKEN }}
 
       - name: Finish norelease branch
         id: finish-norelease-branch
@@ -390,4 +417,4 @@ jobs:
             && git push origin --delete ${{ env.SOURCE_BRANCH }} \
             || :
         env:
-          GH_TOKEN: ${{ env.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ env.TOKEN }}

changelog.md

@@ -1,3 +1,11 @@
+## 2.2.1
+
+- fix: use TOKEN instead of GITHUB_TOKEN
+
+## 2.2.0
+
+- feature: support fetching github token from github app
+
 ## 2.1.2
 
 - fix: solve issue that DEVELOP_BRANCH input is not used

readme.md

@@ -34,7 +34,10 @@ A implementation of workflows of GitHub Actions to support using gitflow on GitH
         #   VERSION_HEADER: ... # Default: '## '
         #   CHANGELOG: ... # Default: 'changelog.md'
         # secrets:
-        #   TOKEN: ... # Default: Github Action token
+        #   GITHUB_TOKEN: ... # Default: GitHub Action token
+        #   GITHUB_APP_ID: ... # Default: GitHub App ID for fetching GitHub token
+        #   GITHUB_APP_PRIVATE_KEY: ... # Default: GitHub App ID for fetching GitHub token
+        #   GITHUB_APP_OWNER: ... # Default: GitHub App ID for fetching GitHub token
     ```
 4. Set `Workflow permissions` as checking `Read and write permissions` and `Allow GitHub Actions to create and approve pull requests`.
 5. Do not check `Automatically delete head branches`.