feat: add signoff option (#360)

Author: technote-space

README.ja.md

@@ -62,33 +62,34 @@
 ![behavior](https://raw.githubusercontent.com/technote-space/toc-generator/images/screenshot.gif)
 
 ## オプション
-| name | description | default | required | e.g. |
-|:---|:---|:---|:---|:---|
-|TARGET_PATHS|対象のファイルパス (カンマ区切り, [詳細](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))|`README*.md`|true|`README*.md,CHANGELOG.md`, `.`|
-|TOC_TITLE|目次タイトル|`**Table of Contents**`| |`''`|
-|MAX_HEADER_LEVEL|Heading最大レベル ([詳細](https://github.com/thlorenz/doctoc#specifying-a-maximum-heading-level-for-toc-entries))| | |`3`|
-|CUSTOM_MODE|Customモードかどうか([生成例](samples/README.horizontal.md))|`false`| |`true`|
-|CUSTOM_TEMPLATE|Customテンプレート(Customモード)|`<p align="center">${ITEMS}</p>`| | |
-|ITEM_TEMPLATE|アイテムテンプレート(Customモード)|`<a href="${LINK}">${TEXT}</a>`| | |
-|SEPARATOR|セパレータ(Customモード)|<code>\<span>&#124;\</span></code>| | |
-|FOLDING|目次を折りたたみ式にするかどうか|`false`| |`true`|
-|COMMIT_MESSAGE|コミットメッセージ|`chore(docs): update TOC`|true|`docs: update TOC`|
-|COMMIT_NAME|コミット時に設定する名前|`${github.actor}`| | |
-|COMMIT_EMAIL|コミット時に設定するメールアドレス|`${github.actor}@users.noreply.github.com`| | |
-|CREATE_PR|プルリクエストを作成するかどうか|`false`| |`true`|
-|CHECK_ONLY_DEFAULT_BRANCH|デフォルトのブランチのみをチェックするかどうか|`false`| |`true`|
-|PR_BRANCH_PREFIX|プルリクエストのブランチプリフィックス|`toc-generator/`|true| |
-|PR_BRANCH_NAME|プルリクエストのブランチ名<br>[Context variables](#context-variables)|`update-toc-${PR_ID}`|true|`toc-${PR_NUMBER}`|
-|PR_TITLE|プルリクエストのタイトル<br>[Context variables](#context-variables)|`chore(docs): update TOC (${PR_MERGE_REF})`|true|`docs: update TOC`|
-|PR_BODY|プルリクエストの本文<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)|true| |
-|PR_COMMENT_BODY|プルリクエストの本文(コメント用)<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)| | |
-|PR_CLOSE_MESSAGE|プルリクエストを閉じるときのメッセージ|`This PR has been closed because it is no longer needed.`| | |
-|TARGET_BRANCH_PREFIX|ブランチ名のフィルタ| | |`release/`|
-|INCLUDE_LABELS|プルリクエストに付与されているかチェックするラベル| | |`Label1, Label2`|
-|OPENING_COMMENT|開始コメント (DocToc以外のため)|`<!-- toc `| | |
-|CLOSING_COMMENT|終了コメント (DocToc以外のため)|`<!-- tocstop `| | |
-|SKIP_COMMENT|スキップコメント| | |`<!-- toc skip `|
-|GITHUB_TOKEN|アクセストークン|`${{github.token}}`|true|`${{secrets.ACCESS_TOKEN}}`|
+| name | description | default | e.g. |
+|:---|:---|:---|:---|
+|TARGET_PATHS|対象のファイルパス (カンマ区切り, [詳細](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))|`README*.md`|`README*.md,CHANGELOG.md`, `.`|
+|TOC_TITLE|目次タイトル|`**Table of Contents**`|`''`|
+|MAX_HEADER_LEVEL|Heading最大レベル ([詳細](https://github.com/thlorenz/doctoc#specifying-a-maximum-heading-level-for-toc-entries))| |`3`|
+|CUSTOM_MODE|Customモードかどうか([生成例](samples/README.horizontal.md))|`false`|`true`|
+|CUSTOM_TEMPLATE|Customテンプレート(Customモード)|`<p align="center">${ITEMS}</p>`| |
+|ITEM_TEMPLATE|アイテムテンプレート(Customモード)|`<a href="${LINK}">${TEXT}</a>`| |
+|SEPARATOR|セパレータ(Customモード)|<code>\<span>&#124;\</span></code>| |
+|FOLDING|目次を折りたたみ式にするかどうか|`false`|`true`|
+|COMMIT_MESSAGE|コミットメッセージ|`chore(docs): update TOC`|`docs: update TOC`|
+|COMMIT_NAME|コミット時に設定する名前|`${github.actor}`| |
+|COMMIT_EMAIL|コミット時に設定するメールアドレス|`${github.actor}@users.noreply.github.com`| |
+|CREATE_PR|プルリクエストを作成するかどうか|`false`|`true`|
+|CHECK_ONLY_DEFAULT_BRANCH|デフォルトのブランチのみをチェックするかどうか|`false`|`true`|
+|PR_BRANCH_PREFIX|プルリクエストのブランチプリフィックス|`toc-generator/`| |
+|PR_BRANCH_NAME|プルリクエストのブランチ名<br>[Context variables](#context-variables)|`update-toc-${PR_ID}`|`toc-${PR_NUMBER}`|
+|PR_TITLE|プルリクエストのタイトル<br>[Context variables](#context-variables)|`chore(docs): update TOC (${PR_MERGE_REF})`|`docs: update TOC`|
+|PR_BODY|プルリクエストの本文<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)| |
+|PR_COMMENT_BODY|プルリクエストの本文(コメント用)<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)| |
+|PR_CLOSE_MESSAGE|プルリクエストを閉じるときのメッセージ|`This PR has been closed because it is no longer needed.`| |
+|TARGET_BRANCH_PREFIX|ブランチ名のフィルタ| |`release/`|
+|INCLUDE_LABELS|プルリクエストに付与されているかチェックするラベル| |`Label1, Label2`|
+|OPENING_COMMENT|開始コメント (DocToc以外のため)|`<!-- toc `| |
+|CLOSING_COMMENT|終了コメント (DocToc以外のため)|`<!-- tocstop `| |
+|SKIP_COMMENT|スキップコメント| |`<!-- toc skip `|
+|GITHUB_TOKEN|アクセストークン|`${{github.token}}`|`${{secrets.ACCESS_TOKEN}}`|
+|SIGNOFF| Signed-off-byを付与 | |`true`|
 
 ### 個別に指定
 [doctoc](https://github.com/technote-space/doctoc#example) に使用されているオプションはコメントで値を指定することが可能です。  

README.md

@@ -63,33 +63,34 @@ e.g. `README.md`
 ![behavior](https://raw.githubusercontent.com/technote-space/toc-generator/images/screenshot.gif)
 
 ## Options
-| name | description | default | required | e.g. |
-|:---|:---|:---|:---|:---|
-|TARGET_PATHS|Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))|`README*.md`|true|`README*.md,CHANGELOG.md`, `.`|
-|TOC_TITLE|TOC Title|`**Table of Contents**`| |`''`|
-|MAX_HEADER_LEVEL|Maximum heading level. ([Detail](https://github.com/thlorenz/doctoc#specifying-a-maximum-heading-level-for-toc-entries))| | |`3`|
-|CUSTOM_MODE|Whether it is custom mode([Generated Example](samples/README.horizontal.md))|`false`| |`true`|
-|CUSTOM_TEMPLATE|Custom template for custom mode|`<p align="center">${ITEMS}</p>`| | |
-|ITEM_TEMPLATE|Item template for custom mode|`<a href="${LINK}">${TEXT}</a>`| | |
-|SEPARATOR|Separator for custom mode|<code>\<span>&#124;\</span></code>| | |
-|FOLDING|Whether to make TOC foldable|`false`| |`true`|
-|COMMIT_MESSAGE|Commit message|`chore(docs): update TOC`|true|`docs: update TOC`|
-|COMMIT_NAME|Git commit name|`${github.actor}`| | |
-|COMMIT_EMAIL|Git commit email|`${github.actor}@users.noreply.github.com`| | |
-|CREATE_PR|Whether to create PullRequest|`false`| |`true`|
-|CHECK_ONLY_DEFAULT_BRANCH|Whether to check only default branch|`false`| |`true`|
-|PR_BRANCH_PREFIX|PullRequest branch prefix|`toc-generator/`|true| |
-|PR_BRANCH_NAME|PullRequest branch name<br>[Context variables](#context-variables)|`update-toc-${PR_ID}`|true|`toc-${PR_NUMBER}`|
-|PR_TITLE|PullRequest title<br>[Context variables](#context-variables)|`chore(docs): update TOC (${PR_MERGE_REF})`|true|`docs: update TOC`|
-|PR_BODY|PullRequest body<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)|true| |
-|PR_COMMENT_BODY|PullRequest body for comment<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)| | |
-|PR_CLOSE_MESSAGE|Message body when closing PullRequest|`This PR has been closed because it is no longer needed.`| | |
-|TARGET_BRANCH_PREFIX|Filter by branch name| | |`release/`|
-|INCLUDE_LABELS|Labels used to check if the PullRequest has it| | |`Label1, Label2`|
-|OPENING_COMMENT|Opening comment (for other than DocToc)|`<!-- toc `| | |
-|CLOSING_COMMENT|Closing comment (for other than DocToc)|`<!-- tocstop `| | |
-|SKIP_COMMENT|Skip comment| | |`<!-- toc skip `|
-|GITHUB_TOKEN|Access token|`${{github.token}}`|true|`${{secrets.ACCESS_TOKEN}}`|
+| name | description | default | e.g. |
+|:---|:---|:---|:---|
+|TARGET_PATHS|Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))|`README*.md`|`README*.md,CHANGELOG.md`, `.`|
+|TOC_TITLE|TOC Title|`**Table of Contents**`|`''`|
+|MAX_HEADER_LEVEL|Maximum heading level. ([Detail](https://github.com/thlorenz/doctoc#specifying-a-maximum-heading-level-for-toc-entries))| |`3`|
+|CUSTOM_MODE|Whether it is custom mode([Generated Example](samples/README.horizontal.md))|`false`|`true`|
+|CUSTOM_TEMPLATE|Custom template for custom mode|`<p align="center">${ITEMS}</p>`| |
+|ITEM_TEMPLATE|Item template for custom mode|`<a href="${LINK}">${TEXT}</a>`| |
+|SEPARATOR|Separator for custom mode|<code>\<span>&#124;\</span></code>| |
+|FOLDING|Whether to make TOC foldable|`false`|`true`|
+|COMMIT_MESSAGE|Commit message|`chore(docs): update TOC`|`docs: update TOC`|
+|COMMIT_NAME|Git commit name|`${github.actor}`| |
+|COMMIT_EMAIL|Git commit email|`${github.actor}@users.noreply.github.com`| |
+|CREATE_PR|Whether to create PullRequest|`false`|`true`|
+|CHECK_ONLY_DEFAULT_BRANCH|Whether to check only default branch|`false`|`true`|
+|PR_BRANCH_PREFIX|PullRequest branch prefix|`toc-generator/`| |
+|PR_BRANCH_NAME|PullRequest branch name<br>[Context variables](#context-variables)|`update-toc-${PR_ID}`|`toc-${PR_NUMBER}`|
+|PR_TITLE|PullRequest title<br>[Context variables](#context-variables)|`chore(docs): update TOC (${PR_MERGE_REF})`|`docs: update TOC`|
+|PR_BODY|PullRequest body<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)| |
+|PR_COMMENT_BODY|PullRequest body for comment<br>[Context PR variables](#context-pr-variables)|[action.yml](action.yml)| |
+|PR_CLOSE_MESSAGE|Message body when closing PullRequest|`This PR has been closed because it is no longer needed.`| |
+|TARGET_BRANCH_PREFIX|Filter by branch name| |`release/`|
+|INCLUDE_LABELS|Labels used to check if the PullRequest has it| |`Label1, Label2`|
+|OPENING_COMMENT|Opening comment (for other than DocToc)|`<!-- toc `| |
+|CLOSING_COMMENT|Closing comment (for other than DocToc)|`<!-- tocstop `| |
+|SKIP_COMMENT|Skip comment| |`<!-- toc skip `|
+|GITHUB_TOKEN|Access token|`${{github.token}}`|`${{secrets.ACCESS_TOKEN}}`|
+|SIGNOFF| Add `Signed-off-by` line | |`true`|
 
 ### Specify options individually
 The options used for [doctoc](https://github.com/technote-space/doctoc#example) can be commented to specify values.  

action.yml

@@ -12,6 +12,9 @@ inputs:
   API_TOKEN:
     description: Secret GitHub API token used to make API requests.
     required: false
+  SIGNOFF:
+    description: 'Add `Signed-off-by` line by the committer at the end of the commit log message.'
+    required: false
 
   TARGET_PATHS:
     description: Target file path. (Comma separated, @see https://github.com/thlorenz/doctoc#adding-toc-to-individual-files)

src/utils/misc.test.ts

@@ -110,6 +110,7 @@ describe('getRunnerArguments', () => {
       prTitleForDefaultBranch: '',
       targetBranchPrefix: '',
       targetEvents: TARGET_EVENTS,
+      signoff: false,
     });
   });
 
@@ -135,6 +136,7 @@ describe('getRunnerArguments', () => {
     process.env.INPUT_TARGET_PATHS              = '/';
     process.env.INPUT_CREATE_PR                 = 'false';
     process.env.INPUT_CHECK_ONLY_DEFAULT_BRANCH = 'true';
+    process.env.INPUT_SIGNOFF                   = 'true';
 
     const args = getRunnerArguments();
     delete args.logger;
@@ -171,6 +173,7 @@ describe('getRunnerArguments', () => {
       prTitleForDefaultBranch: 'test-default-branch: create pull request (${PR_NUMBER})',
       targetBranchPrefix: 'feature/',
       targetEvents: TARGET_EVENTS,
+      signoff: true,
     });
   });
 });

src/utils/misc.ts

@@ -64,6 +64,7 @@ export const getRunnerArguments = (): MainArguments => {
     targetEvents: TARGET_EVENTS,
     notCreatePr: !Utils.getBoolValue(getInput('CREATE_PR')),
     checkOnlyDefaultBranch: Utils.getBoolValue(getInput('CHECK_ONLY_DEFAULT_BRANCH')),
+    signoff: Utils.getBoolValue(getInput('SIGNOFF')),
   };
 };
 

src/utils/process.test.ts

@@ -307,6 +307,7 @@ describe('main', () => {
     process.env.INPUT_MAX_HEADER_LEVEL = '1';
     process.env.INPUT_ENTRY_PREFIX     = '☆';
     process.env.INPUT_CREATE_PR        = 'true';
+    process.env.INPUT_SIGNOFF          = 'true';
     const mockStdout                   = spyOnStdout();
     const mockOutput                   = spyOnSetOutput();
     setChildProcessParams({
@@ -380,7 +381,7 @@ describe('main', () => {
       '[command]git config \'user.email\' \'[email protected]\'',
       '::endgroup::',
       '::group::Committing...',
-      '[command]git commit -qm \'chore(docs): update TOC\'',
+      '[command]git commit --signoff -qm \'chore(docs): update TOC\'',
       '[command]git show \'--stat-count=10\' HEAD',
       '::endgroup::',
       '::group::Checking references diff...',