README関連修正 (#103)

* README修正

* action.ymlを元にREADMEを生成する

* token周り修正

* 条件修正

* inputsの順番変更

* README修正 (#108)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: massongit

.github/workflows/update-readme.yml

@@ -0,0 +1,64 @@
+---
+name: update-readme
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3.0.2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      - uses: actions/setup-node@v3.3.0
+        with:
+          cache: npm
+      - run: npm ci --prefer-offline
+      - run: echo "DESCRIPTION=$(yq '.description' action.yml)" >> "${GITHUB_ENV}"
+      - name: Get inputs markdown
+        id: get_inputs_markdown
+        uses: actions/github-script@v6.1.0
+        env:
+          HEAD_REF: ${{github.event.pull_request.head.ref}}
+        with:
+          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")
+      - env:
+          DESCRIPTION: ${{env.DESCRIPTION}}
+          INPUTS: ${{steps.get_inputs_markdown.outputs.result}}
+        run: envsubst < README.template.md > README.md
+      - uses: ./
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          branch-name-prefix: fix-readme
+          pr-title-prefix: README修正
+          pr-description-prefix: READMEを修正しました。
+          repo-name: ${{ github.event.pull_request.head.repo.full_name }}

README.md

@@ -1,6 +1,6 @@
 # actions-diff-pr-management
 
-PRのブランチに対して、フォーマッタによって修正された結果を、PRにするGitHub Actionsです。
+PRのブランチに対して、フォーマッタを実行した結果をPRにするGitHub Actionsです。
 
 本Actionsを使わずにフォーマットを修正した場合、自動的にPRを閉じます。
 
@@ -38,13 +38,13 @@ jobs:
 
 ## 引数
 
-|          引数名          |                           説明                            | 必須  |
-|:---------------------:|:-------------------------------------------------------:|:---:|
-|     github-token      |                      GitHubのトークン。                       |  O  |
-|       repo-name       | リポジトリ名。 `pull_request` 以外のトリガーも設定している場合はリポジトリ名を決め打ちで入力。 |  O  |
-|  branch-name-prefix   |                      branch名の接頭語。                       |     |
-|    pr-title-prefix    |                      PRのタイトルの接頭語。                       |     |
-| pr-description-prefix |                         本文の接頭語。                         |     |
+| 引数名 | 説明 | 必須 |
+|:---:|:---:|:---:|
+| github-token | GitHubのトークン。 | O |
+| repo-name | リポジトリ名。 `pull_request` 以外のトリガーも設定している場合はリポジトリ名を決め打ちで入力。 | O |
+| branch-name-prefix | branch名の接頭語。 |  |
+| pr-title-prefix | PRのタイトルの接頭語。 |  |
+| pr-description-prefix | 本文の接頭語。 |  |
 
 ## 開発
 

README.template.md

@@ -0,0 +1,48 @@
+# actions-diff-pr-management
+
+${DESCRIPTION}
+
+本Actionsを使わずにフォーマットを修正した場合、自動的にPRを閉じます。
+
+## 注意点
+
+元のPRを閉じた場合、本Actionsが立てたPRは残ります。  
+このような場合、 <https://github.com/dev-hato/actions-close-pr> を併用することで自動的にPRを閉じることができます。
+
+## 使い方
+
+```yaml
+on:
+  pull_request:
+
+jobs:
+  diff-pr-management:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      - run: hoge fmt # FIXME フォーマッタを走らせる
+      - uses: dev-hato/actions-diff-pr-management@v1
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          repo-name: ${{ github.event.pull_request.head.repo.full_name }}
+```
+
+## 例
+
+* 元のPR: <https://github.com/dev-hato/actions-diff-pr-management/pull/96>
+* 本Actionsによって作成されたPR: <https://github.com/dev-hato/actions-diff-pr-management/pull/98>
+
+## 引数
+
+${INPUTS}
+
+## 開発
+
+### 設定
+
+<https://pre-commit.com/> の手順に従って `pre-commit` をインストールします。  
+これにより、コミット時にクレデンシャルが含まれていないかの検査が行われるようになります。

action.yml

@@ -1,25 +1,25 @@
 name: 'diff-pr-management'
 author: 'dev-hato Development Team'
-description: '差分があればPRを作り、差分がなければPRを閉じます'
+description: 'PRのブランチに対して、フォーマッタを実行した結果をPRにするGitHub Actionsです。'
 inputs:
   github-token: # id of input
-    description: 'GITHUB_TOKEN'
+    description: 'GitHubのトークン。'
+    required: true
+  repo-name:
+    description: 'リポジトリ名。 `pull_request` 以外のトリガーも設定している場合はリポジトリ名を決め打ちで入力。'
     required: true
   branch-name-prefix:
-    description: 'Prefix of PR branch name'
+    description: 'branch名の接頭語。'
     required: true
     default: fix
   pr-title-prefix:
-    description: 'Prefix of PR title'
+    description: 'PRのタイトルの接頭語。'
     required: true
     default: fix
   pr-description-prefix:
-    description: 'Prefix of PR description'
+    description: '本文の接頭語。'
     required: true
     default: ""
-  repo-name:
-    description: 'Repository name'
-    required: true
 runs:
   using: "composite"
   steps: