actions-marketplace-validations/github-docs-to-wiki
Converts markdown content in a repository into a wiki.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| githubToken | The GitHub PAT, used to clone the wiki repo | yes | — |
| defaultBranch | The default branch name (master, main, etc) | no | — |
| rootDocsFolder | A directory within the repository where the docs are located | no | — |
| convertRootReadmeToHomePage | If true, renames the README.md file to Home.md in the wiki (the wiki homepage) | no | false |
| useHeaderForWikiName | If true, names wiki pages according to the top header of the source file (using `#`) | no | false |
| customWikiFileHeaderFormat | If set, inserts a header at the top of each wiki file with the given format Supports the following format subsitutions: - {sourceFileLink}: the absolute url to the source file in the repo | no | — |
| customCommitMessageFormat | If set, uses the given format for the commit message to the wiki. Useful to correlate changes to the source. Supports the following format subsitutions: - {commitMessage}: the latest commit message for HEAD - {shaFull}: the full SHA of HEAD - {shaShort}: the short SHA of HEAD | no | — |
Outputs
no outputs