READMEの目次の生成を自動化するGitHub Actions
READMEなどの目次を自動生成する GitHub Actions です。
導入手順
目次の位置を指定する
目次を入れたいマークダウンファイル内に以下のようなコメントを追加します。
例：README.md
<!-- START doctoc -->
<!-- END doctoc -->workflowを設定
例：.github/workflows/toc.yml
on: push
name: TOC Generator
jobs:
generateTOC:
name: TOC Generator
runs-on: ubuntu-latest
steps:
- name: TOC Generator
uses: technote-space/toc-generator@v2
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}オプション
TARGET_PATHS
対象のファイルパス (カンマ区切り, 詳細)
default: 'README*.md'
例：.
TOC_TITLE
目次タイトル
default: '**Table of Contents**'
例：''
COMMIT_MESSAGE
コミットメッセージ
default: 'docs: Update TOC'
例：feat: update TOC
COMMIT_NAME
コミット名
default: '${github.actor}'
COMMIT_EMAIL
コミットメールアドレス
default: '${github.actor}@users.noreply.github.com'
TARGET_BRANCH_PREFIX
ブランチ名のフィルタ
特定のブランチでのみ動作させる場合に使用します。
default: ''
例：'release/'
INCLUDE_LABELS
プルリクエストに付与されているかチェックするラベル
default: ''
例：'Label1, Label2'
例：
INCLUDE_LABELS: |
Test Label1
Test Label2プルリクエストの作成
変更を直接プッシュする代わりにプルリクエストを作成することも可能です。
on: pull_request
name: TOC Generator
jobs:
generateTOC:
name: TOC Generator
runs-on: ubuntu-latest
steps:
- name: TOC Generator
uses: technote-space/toc-generator@v2
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
closed アクティビティタイプが設定されている場合、不要になったプルリクエストは自動で閉じられます。
プルリクエスト用オプション
PR_BRANCH_PREFIX
プルリクエストのブランチプリフィックス
default: 'toc-generator/'
PR_BRANCH_NAME
プルリクエストのブランチ名
default: 'update-toc-${PR_ID}'
例：toc-${PR_NUMBER}
PR_TITLE
プルリクエストのタイトル
default: 'docs: Update TOC (${PR_MERGE_REF})'
例：feat: update TOC
PR_BODY
プルリクエストの本文
default:
## Base PullRequest
${PR_TITLE} (${PR_NUMBER_REF})
## Command results
<details>
<summary>Details: </summary>
${COMMANDS_OUTPUT}
</details>
## Changed files
<details>
<summary>${FILES_SUMMARY}: </summary>
${FILES}
</details>
<hr>
[:octocat: Repo](${ACTION_URL}) | [:memo: Issues](${ACTION_URL}/issues) | [:department_store: Marketplace](${ACTION_MARKETPLACE_URL})
PR_CLOSE_MESSAGE
プルリクエストを閉じるときのメッセージ
default: 'This PR is no longer needed because the package looks up-to-date.'
使用可能な変数
使用例
