Skip to content

Latest commit

 

History

History
195 lines (169 loc) · 9.8 KB

README.ja.md

File metadata and controls

195 lines (169 loc) · 9.8 KB
Raw

TOC Generator

CI Status codecov CodeFactor License: MIT

Read this in other languages: English, 日本語.

これは目次を生成するGitHub Actionです。
DocToc を実行し変更があればコミットします。

Table of Contents

Details

インストール

  1. 目次の位置を指定 (option) 
    <!-- START doctoc -->
<!-- END doctoc -->
    詳細
  2. workflow を設定
    例：.github/workflows/toc.yml 
    on: push
name: TOC Generator
jobs:
  generateTOC:
    name: TOC Generator
    runs-on: ubuntu-latest
    steps:
      - uses: technote-space/toc-generator@v2

スクリーンショット

behavior

オプション

name description default required e.g.
TARGET_PATHS 対象のファイルパス (カンマ区切り, 詳細) README*.md true README*.md,CHANGELOG.md, .
TOC_TITLE 目次タイトル **Table of Contents** ''
MAX_HEADER_LEVEL Heading最大レベル (詳細) 3
FOLDING 目次を折りたたみ式にするかどうか false true
COMMIT_MESSAGE コミットメッセージ docs: update TOC true feat: update TOC
COMMIT_NAME コミット時に設定する名前 ${github.actor}
COMMIT_EMAIL コミット時に設定するメールアドレス ${github.actor}@users.noreply.github.com
CREATE_PR プルリクエストを作成するかどうか true false
PR_BRANCH_PREFIX プルリクエストのブランチプリフィックス toc-generator/ true
PR_BRANCH_NAME プルリクエストのブランチ名
Context variables		 update-toc-${PR_ID} true toc-${PR_NUMBER}
PR_TITLE プルリクエストのタイトル
Context variables		 docs: update TOC (${PR_MERGE_REF}) true feat: update TOC
PR_BODY プルリクエストの本文
Context PR variables		 action.yml true
PR_COMMENT_BODY プルリクエストの本文（コメント用）
Context PR variables		 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
GITHUB_TOKEN アクセストークン ${{github.token}} true ${{secrets.ACCESS_TOKEN}}

Action イベント詳細

対象イベント

eventName: action condition
push: * condition1
pull_request: [opened, synchronize, reopened, labeled, unlabeled] condition2
pull_request: [closed]
  • 次のアクティビティタイプは明示的に指定する必要があります。 (詳細)
    • labeled, unlabeled, closed

Conditions

condition1

  • ブランチへのプッシュ (タグのプッシュではない)

condition2

補足

GITHUB_TOKEN

GitHub Actions で提供されるGITHUB_TOKENは連続するイベントを作成する権限がありません。
したがって、プッシュによってトリガーされるビルドアクションなどは実行されません。

これはブランチプロテクションを設定していると問題になる場合があります。

もしアクションをトリガーしたい場合は代わりにpersonal access tokenを使用してください。

  1. public_repo または repo の権限で Personal access token を生成
    (repo はプライベートリポジトリで必要です)
  2. ACCESS_TOKENとして保存
  3. GITHUB_TOKENの代わりにACCESS_TOKENを使用するように設定
    例：.github/workflows/toc.yml 
    on: push
name: TOC Generator
jobs:
  generateTOC:
    name: TOC Generator
    runs-on: ubuntu-latest
    steps:
      - uses: technote-space/toc-generator@v2
        with:
          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}

プルリクエストの作成

CREATE_PR に true (default) を設定 かつ pull_request イベントを設定した場合は、変更はプルリクエストにコミットされます。

on: pull_request
name: TOC Generator
jobs:
 generateTOC:
   name: TOC Generator
   runs-on: ubuntu-latest
   steps:
     - uses: technote-space/toc-generator@v2

create pr

closedアクティビティタイプが設定されている場合、このアクションは不要になったプルリクエストを閉じます。

on:
  pull_request:
    types: [opened, synchronize, reopened, closed]
name: TOC Generator
jobs:
 generateTOC:
   name: TOC Generator
   runs-on: ubuntu-latest
   steps:
     - uses: technote-space/toc-generator@v2

Context variables

name description
PR_NUMBER pull_request.number (例：11)
PR_NUMBER_REF #${pull_request.number} (例：#11)
PR_ID pull_request.id (例：21031067)
PR_HEAD_REF pull_request.head.ref (例：change)
PR_BASE_REF pull_request.base.ref (例：master)
PR_MERGE_REF pull_request.base.ref (例：change -> master)
PR_TITLE pull_request.title (例：update the README with new information.)

Payload example

Context PR variables

name description
PR_LINK プルリクエストへのリンク
COMMANDS_OUTPUT TOC コマンドの結果
FILES_SUMMARY 例：Changed 2 files
FILES 変更されたファイル一覧

このアクションを使用しているリポジトリの例

Author

GitHub (Technote)
Blog