CI内のスクリプトを別ファイルに分離する (#381)

* 複数行のスクリプトを分離する

* Revert name

* envを各stepに移動

* Fix path

* Fix style

* スクリプトを別ファイルに分離する

* Revert name

* 1行のbashコマンドを元に戻す

Author: massongit

.github/workflows/update-readme.yml

@@ -37,25 +37,8 @@ jobs:
           github-token: ${{secrets.GITHUB_TOKEN}}
           result-encoding: string
           script: |
-            const fs = require('fs')
-            const yaml = require('js-yaml')
-
-            const yml_file = yaml.load(fs.readFileSync('action.yml', 'utf8'))
-            const inputs = yml_file.inputs
-            const rows = ['| 引数名 | 説明 | 必須 |', '|:---:|:---:|:---:|']
-
-            for (const input_name of Object.keys(inputs)) {
-              let row = `| ${input_name} | ${inputs[input_name].description} | `
-
-              if (inputs[input_name].default === undefined && inputs[input_name].required) {
-                row += 'O'
-              }
-
-              row += ' |'
-              rows.push(row)
-            }
-
-            return rows.join("\n")
+            const script = require('./scripts/update_readme/get_inputs_markdown.js')
+            return script()
       - env:
           DESCRIPTION: ${{env.DESCRIPTION}}
           INPUTS: ${{steps.get_inputs_markdown.outputs.result}}

action.yml

@@ -36,34 +36,19 @@ runs:
       id: diff
       shell: bash
       if: github.event_name != 'pull_request' || github.event.action != 'closed'
-      run: |
-        result=$(git diff --cached)
-        result="${result//'%'/'%25'}"
-        result="${result//$'\n'/'%0A'}"
-        result="${result//$'\r'/'%0D'}"
-        echo "result=$result" >> "${GITHUB_OUTPUT}"
+      run: ${{ github.action_path }}/scripts/action/show_diff.sh
     # 差分があったときは、コミットを作りpushする
     - name: Push
       env:
         HEAD_REF: ${{github.event.pull_request.head.ref}}
+        PR_TITLE_PREFIX: ${{inputs.pr-title-prefix}}
+        AUTHOR: ${{github.actor}}
+        GITHUB_TOKEN: ${{inputs.github-token}}
+        REPOSITORY: ${{github.repository}}
+        BRANCH_NAME_PREFIX: ${{inputs.branch-name-prefix}}
+        BASE_BRANCH: ${{inputs.base-branch}}
       if: inputs.repo-name == github.repository && steps.diff.outputs.result != '' && ((github.event_name == 'pull_request' && github.event.action != 'closed') || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch')
-      run: |
-        git config user.name "github-actions[bot]"
-        EMAIL="41898282+github-actions[bot]@users.noreply.github.com"
-        git config user.email "${EMAIL}"
-        git commit -m "${{inputs.pr-title-prefix}}"
-        REPO_URL="https://"
-        REPO_URL+="${{github.actor}}:${{inputs.github-token}}@github.com/"
-        REPO_URL+="${{github.repository}}.git"
-        GITHUB_HEAD="HEAD:refs/heads/${{inputs.branch-name-prefix}}"
-
-        if [ "${HEAD_REF}" != "" ]; then
-          GITHUB_HEAD+="-${HEAD_REF}"
-        elif [ "${{inputs.base-branch}}" != "" ]; then
-          GITHUB_HEAD+="-${{inputs.base-branch}}"
-        fi
-
-        git push -f "${REPO_URL}" "${GITHUB_HEAD}"
+      run: ${{ github.action_path }}/scripts/action/push.sh
       shell: bash
     - name: Set org name
       uses: actions/[email protected]
@@ -72,165 +57,76 @@ runs:
       with:
         github-token: ${{inputs.github-token}}
         result-encoding: string
-        script: return process.env.GITHUB_REPOSITORY.split('/')[0]
+        script: |
+          const script = require('${{ github.action_path }}/scripts/action/set_org_name.js')
+          return script()
     - name: Get HEAD_REF
       uses: actions/[email protected]
       env:
         HEAD_REF: ${{github.event.pull_request.head.ref}}
+        BASE_BRANCH: ${{inputs.base-branch}}
       if: inputs.repo-name == github.repository
       id: get_head_ref
       with:
         github-token: ${{inputs.github-token}}
         result-encoding: string
         script: |
-          let HEAD_REF = process.env["HEAD_REF"]
-
-          if (HEAD_REF === "" && "${{inputs.base-branch}}" !== "") {
-            return "${{inputs.base-branch}}"
-          }
-
-          return HEAD_REF
+          const script = require('${{ github.action_path }}/scripts/action/get_head_ref.js')
+          return script()
     - name: Get PullRequests
       uses: actions/[email protected]
       if: inputs.repo-name == github.repository && steps.diff.outputs.result != '' && ((github.event_name == 'pull_request' && github.event.action != 'closed') || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch')
       id: get_pull_requests
+      env:
+        HEAD_REF: ${{steps.get_head_ref.outputs.result}}
+        ORG_NAME: ${{steps.set_org_name.outputs.result}}
+        BRANCH_NAME_PREFIX: ${{inputs.branch-name-prefix}}
       with:
         github-token: ${{inputs.github-token}}
         script: |
-          const HEAD_REF = "${{steps.get_head_ref.outputs.result}}"
-          let head = "${{steps.set_org_name.outputs.result}}:${{inputs.branch-name-prefix}}"
-
-          if (HEAD_REF != "") {
-            head += "-" + HEAD_REF
-          }
-
-          const pulls_list_params = {
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            head,
-            base: HEAD_REF,
-            state: "open"
-          }
-          console.log("call pulls.list:", pulls_list_params)
-          const pulls = await github.paginate(github.rest.pulls.list,
-                                              pulls_list_params)
-          return pulls.length
+          const script = require('${{ github.action_path }}/scripts/action/get_pull_requests.js')
+          return await script({github, context})
     # pushしたブランチでPRを作る
     - name: Create PullRequest
       uses: actions/[email protected]
       if: inputs.repo-name == github.repository && steps.diff.outputs.result != '' && steps.get_pull_requests.outputs.result == 0 && ((github.event_name == 'pull_request' && github.event.action != 'closed') || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch')
       id: create_pull_request
+      env:
+        HEAD_REF: ${{steps.get_head_ref.outputs.result}}
+        ORG_NAME: ${{steps.set_org_name.outputs.result}}
+        PR_DESCRIPTION_PREFIX: ${{inputs.pr-description-prefix}}
+        PR_NUMBER: ${{github.event.pull_request.number}}
+        PR_TITLE_PREFIX: ${{inputs.pr-title-prefix}}
+        BRANCH_NAME_PREFIX: ${{inputs.branch-name-prefix}}
       with:
         github-token: ${{inputs.github-token}}
         script: |
-          const HEAD_REF = "${{steps.get_head_ref.outputs.result}}"
-          let head = "${{inputs.branch-name-prefix}}"
-
-          if (HEAD_REF != "") {
-            head += "-" + HEAD_REF
-          }
-
-          const head_with_repo = `${{steps.set_org_name.outputs.result}}:${head}`
-          let title = "${{inputs.pr-title-prefix}}"
-          let body = "${{inputs.pr-description-prefix}}"
-
-          if ("${{github.event.pull_request.number}}" != "") {
-            body += `本PR ( \`${head}\` ) をマージすると差分が次のPRに反映されます。\n`
-            body += `* #${{github.event.pull_request.number}} ( \`${HEAD_REF}\` )\n`
-            body += "```mermaid\n"
-            body += `%%{init: {'gitGraph': {'mainBranchName': '${HEAD_REF}'}}}%%\n`
-            body += "gitGraph\n"
-
-            for (let i = 0; i < 2; i++) {
-              body += "  commit\n"
-            }
-
-            body += `  branch ${head}\n`
-            body += `  checkout ${head}\n`
-            let commit = "${{inputs.pr-title-prefix}}"
-
-            if (6 < commit.length) {
-              commit = commit.substring(0, 6) + '......'
-            }
-
-            body += `  commit id: "${commit}"\n`
-            body += `  checkout ${HEAD_REF}\n`
-            body += `  merge ${head}\n`
-            body += "```"
-            title += " #${{github.event.pull_request.number}}"
-          }
-
-          const pulls_create_params = {
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            head: head_with_repo,
-            base: HEAD_REF,
-            title,
-            body
-          }
-          console.log("call pulls.create:", pulls_create_params)
-          const create_pull_res = await github.rest.pulls.create(
-                                    pulls_create_params
-                                  )
-          return create_pull_res.data.number
+          const script = require('${{ github.action_path }}/scripts/action/create_pull_request.js')
+          return await script({github, context})
     - name: Assign a user
       uses: actions/[email protected]
       if: inputs.repo-name == github.repository && steps.diff.outputs.result != '' && steps.get_pull_requests.outputs.result == 0 && github.event_name == 'pull_request' && github.event.action != 'closed' && github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.user.login != 'renovate[bot]'
+      env:
+        PR_NUMBER: ${{steps.create_pull_request.outputs.result}}
+        ASSIGN_USER: ${{github.event.pull_request.user.login}}
       with:
         github-token: ${{inputs.github-token}}
         script: |
-          const issues_add_assignees_params = {
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            issue_number: ${{steps.create_pull_request.outputs.result}},
-            assignees: ["${{github.event.pull_request.user.login}}"]
-          }
-          console.log("call issues.addAssignees:")
-          console.log(issues_add_assignees_params)
-          await github.rest.issues.addAssignees(issues_add_assignees_params)
+          const script = require('${{ github.action_path }}/scripts/action/assign_a_user.js')
+          await script({github, context})
     # 既にformat修正のPRがある状態で、手動でformatを修正した場合、format修正のPRを閉じる
     - name: Close PullRequest
       uses: actions/[email protected]
       if: inputs.repo-name == github.repository && ((github.event_name == 'pull_request' && (github.event.action == 'closed' || steps.diff.outputs.result == '')) || ((github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') && steps.diff.outputs.result == ''))
+      env:
+        HEAD_REF: ${{steps.get_head_ref.outputs.result}}
+        ORG_NAME: ${{steps.set_org_name.outputs.result}}
+        BRANCH_NAME_PREFIX: ${{inputs.branch-name-prefix}}
       with:
         github-token: ${{inputs.github-token}}
         script: |
-          const HEAD_REF = "${{steps.get_head_ref.outputs.result}}"
-          let head_name = "${{inputs.branch-name-prefix}}"
-
-          if (HEAD_REF != "") {
-            head_name += "-" + HEAD_REF
-          }
-
-          const common_params = {
-            owner: context.repo.owner,
-            repo: context.repo.repo
-          }
-          const pulls_list_params = {
-            head: "${{steps.set_org_name.outputs.result}}:" + head_name,
-            base: HEAD_REF,
-            state: "open",
-            ...common_params
-          }
-          console.log("call pulls.list:", pulls_list_params)
-          const pulls = await github.paginate(github.rest.pulls.list,
-                                              pulls_list_params)
-
-          for (const pull of pulls) {
-            const pulls_update_params = {
-              pull_number: pull.number,
-              state: "closed",
-              ...common_params
-            }
-            console.log("call pulls.update:", pulls_update_params)
-            await github.rest.pulls.update(pulls_update_params)
-            const git_deleteRef_params = {
-              ref: "heads/" + head_name,
-              ...common_params
-            }
-            console.log("call git.deleteRef:", git_deleteRef_params)
-            await github.rest.git.deleteRef(git_deleteRef_params)
-          }
+          const script = require('${{ github.action_path }}/scripts/action/close_pull_request.js')
+          await script({github, context})
     - name: Exit
       if: (github.event_name != 'pull_request' || github.event.action != 'closed') && steps.diff.outputs.result != ''
       run: exit 1

scripts/action/assign_a_user.js

@@ -0,0 +1,11 @@
+module.exports = async ({ github, context }) => {
+  const issuesAddAssigneesParams = {
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    issue_number: process.env.PR_NUMBER,
+    assignees: [process.env.ASSIGN_USER]
+  }
+  console.log('call issues.addAssignees:')
+  console.log(issuesAddAssigneesParams)
+  await github.rest.issues.addAssignees(issuesAddAssigneesParams)
+}

scripts/action/close_pull_request.js

@@ -0,0 +1,37 @@
+module.exports = async ({ github, context }) => {
+  const HEAD_REF = process.env.HEAD_REF
+  let headName = process.env.BRANCH_NAME_PREFIX
+
+  if (HEAD_REF !== '') {
+    headName += '-' + HEAD_REF
+  }
+
+  const commonParams = {
+    owner: context.repo.owner,
+    repo: context.repo.repo
+  }
+  const pullsListParams = {
+    head: process.env.ORG_NAME + ':' + headName,
+    base: HEAD_REF,
+    state: 'open',
+    ...commonParams
+  }
+  console.log('call pulls.list:', pullsListParams)
+  const pulls = await github.paginate(github.rest.pulls.list, pullsListParams)
+
+  for (const pull of pulls) {
+    const pullsUpdateParams = {
+      pull_number: pull.number,
+      state: 'closed',
+      ...commonParams
+    }
+    console.log('call pulls.update:', pullsUpdateParams)
+    await github.rest.pulls.update(pullsUpdateParams)
+    const gitDeleteRefParams = {
+      ref: 'heads/' + headName,
+      ...commonParams
+    }
+    console.log('call git.deleteRef:', gitDeleteRefParams)
+    await github.rest.git.deleteRef(gitDeleteRefParams)
+  }
+}

scripts/action/create_pull_request.js

@@ -0,0 +1,54 @@
+module.exports = async ({ github, context }) => {
+  const HEAD_REF = process.env.HEAD_REF
+  const PR_NUMBER = process.env.PR_NUMBER
+  const PR_TITLE_PREFIX = process.env.PR_TITLE_PREFIX
+  let head = process.env.BRANCH_NAME_PREFIX
+
+  if (HEAD_REF !== '') {
+    head += '-' + HEAD_REF
+  }
+
+  const headWithRepo = process.env.ORG_NAME + ':' + head
+  let title = PR_TITLE_PREFIX
+  let body = process.env.PR_DESCRIPTION_PREFIX
+
+  if (PR_NUMBER !== '') {
+    body += `本PR ( \`${head}\` ) をマージすると差分が次のPRに反映されます。\n`
+    body += `* #${PR_NUMBER} ( \`${HEAD_REF}\` )\n`
+    body += '```mermaid\n'
+    body += `%%{init: {'gitGraph': {'mainBranchName': '${HEAD_REF}'}}}%%\n`
+    body += 'gitGraph\n'
+
+    for (let i = 0; i < 2; i++) {
+      body += '  commit\n'
+    }
+
+    body += `  branch ${head}\n`
+    body += `  checkout ${head}\n`
+    let commit = PR_TITLE_PREFIX
+
+    if (commit.length > 6) {
+      commit = commit.substring(0, 6) + '......'
+    }
+
+    body += `  commit id: "${commit}"\n`
+    body += `  checkout ${HEAD_REF}\n`
+    body += `  merge ${head}\n`
+    body += '```'
+    title += ' #' + PR_NUMBER
+  }
+
+  const pullsCreateParams = {
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    head: headWithRepo,
+    base: HEAD_REF,
+    title,
+    body
+  }
+  console.log('call pulls.create:', pullsCreateParams)
+  const createPullRes = await github.rest.pulls.create(
+    pullsCreateParams
+  )
+  return createPullRes.data.number
+}

scripts/action/get_head_ref.js

@@ -0,0 +1,10 @@
+module.exports = () => {
+  const HEAD_REF = process.env.HEAD_REF
+  const BASE_BRANCH = process.env.BASE_BRANCH
+
+  if (HEAD_REF === '' && BASE_BRANCH !== '') {
+    return BASE_BRANCH
+  }
+
+  return HEAD_REF
+}