technote-space/TOC Generator
GitHub Action to generate TOC.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | Secret GitHub API token used to make API requests or git authentication. | no | ${{ github.token }} |
| API_TOKEN | Secret GitHub API token used to make API requests. | no | — |
| SIGNOFF | Add `Signed-off-by` line by the committer at the end of the commit log message. | no | — |
| TARGET_PATHS | Target file path. (Comma separated, @see https://github.com/thlorenz/doctoc#adding-toc-to-individual-files) | no | README*.md |
| TOC_TITLE | TOC Title | no | **Table of Contents** |
| FOLDING | Whether to fold. | no | — |
| MAX_HEADER_LEVEL | Max header level. | no | — |
| ENTRY_PREFIX | Entry prefix. | no | — |
| OPENING_COMMENT | Opening comment (for other than DocToc) | no | <!-- toc |
| CLOSING_COMMENT | Closing comment (for other than DocToc) | no | <!-- tocstop |
| SKIP_COMMENT | Skip comment | no | — |
| HTML_MODE | Whether it is html mode (deprecated). | no | — |
| HTML_TEMPLATE | Html template for html mode (deprecated) | no | <p align="center">${ITEMS}</p> |
| CUSTOM_MODE | Whether it is custom mode. | no | — |
| CUSTOM_TEMPLATE | CUSTOM template for custom mode | no | — |
| ITEM_TEMPLATE | Item template for custom mode | no | <a href="${LINK}">${TEXT}</a> |
| SEPARATOR | Separator for custom mode | no | <span>|</span> |
| FOOTER | Footer | no | — |
| COMMIT_MESSAGE | Commit message. | no | chore(docs): update TOC |
| COMMIT_NAME | Git commit name. | no | "" |
| COMMIT_EMAIL | Git commit email. | no | "" |
| CREATE_PR | Whether to create PullRequest. | no | — |
| CHECK_ONLY_DEFAULT_BRANCH | Whether to check only default branch. | no | — |
| PR_BRANCH_PREFIX | PullRequest branch prefix. | no | toc-generator/ |
| PR_BRANCH_NAME | PullRequest branch name. | no | update-toc-${PR_ID} |
| PR_TITLE | PullRequest title. | no | chore(docs): update TOC (${PR_MERGE_REF}) |
| PR_BODY | PullRequest body. | no | ## 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_COMMENT_BODY | PullRequest body. | no | ## 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_DEFAULT_BRANCH_PREFIX | PullRequest branch prefix for default branch. | no | "" |
| PR_DEFAULT_BRANCH_NAME | PullRequest branch name for default branch. | no | "" |
| PR_DEFAULT_BRANCH_TITLE | PullRequest title for default branch. | no | "" |
| PR_DEFAULT_BRANCH_BODY | PullRequest body for default branch. | no | "" |
| PR_CLOSE_MESSAGE | Message body when closing PullRequest. | no | This PR has been closed because it is no longer needed. |
| TARGET_BRANCH_PREFIX | Filter by branch name. (e.g. release/) | no | "" |
| INCLUDE_LABELS | Labels used to check if the PullRequest has it. | no | "" |
Outputs
no outputs