READMEに引数のデフォルト値追加 (#1052)

* READMEに引数のデフォルト値追加

* undefinedの場合はデフォルト値を記述しない

* README修正 (#1053)

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

README.md

@@ -38,13 +38,13 @@ jobs:
 
 ## 引数
 
-| 引数名 | 説明 | 必須 |
-|:---:|:---:|:---:|
-| github-token | GitHubのトークン。 | O |
-| branch-name-prefix | branch名の接頭語。 |  |
-| pr-title-prefix | PRのタイトルの接頭語。 |  |
-| pr-description-prefix | 本文の接頭語。 |  |
-| exit-failure | 実行完了時にCIを失敗させるかどうか。 |  |
+| 引数名 | 説明 | 必須 | デフォルト値 |
+|:---:|:---:|:---:|:--:|
+| github-token | GitHubのトークン。 | O |  |
+| branch-name-prefix | branch名の接頭語。 |  | fix |
+| pr-title-prefix | PRのタイトルの接頭語。 |  | fix |
+| pr-description-prefix | 本文の接頭語。 |  |  |
+| exit-failure | 実行完了時にCIを失敗させるかどうか。 |  | true |
 
 ## 対応しているトリガー
 * pull_request

scripts/update_readme/update_readme/get_inputs_markdown.js

@@ -4,7 +4,7 @@ const yaml = require('js-yaml')
 module.exports = () => {
   const ymlFile = yaml.load(fs.readFileSync('action.yml', 'utf8'))
   const inputs = ymlFile.inputs
-  const rows = ['| 引数名 | 説明 | 必須 |', '|:---:|:---:|:---:|']
+  const rows = ['| 引数名 | 説明 | 必須 | デフォルト値 |', '|:---:|:---:|:---:|:--:|']
 
   for (const inputName of Object.keys(inputs)) {
     let row = `| ${inputName} | ${inputs[inputName].description} | `
@@ -13,6 +13,12 @@ module.exports = () => {
       row += 'O'
     }
 
+    row += ' | '
+
+    if (inputs[inputName].default !== undefined) {
+      row += inputs[inputName].default
+    }
+
     row += ' |'
     rows.push(row)
   }