rnett/Publish docs
Publishes docs to github pages
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| from | The location of the docs. Mutually exclusive with from-file | no | — |
| from-file | The location of the doc file. Mutually exclusive with from | no | — |
| publish-to | The folder in the branch to put the docs in. See README.md. | no | — |
| latests | The values to replace $latest with in publish-to. Snapshot, then release, separated by a '|'. | no | snapshot|release |
| branch | The branch to push docs to | no | gh-pages |
| version | The version of the documentation. Used if publish-to is 'version' or 'version+latest' | no | — |
| message | Message for the docs commit | no | — |
| restore | Whether to restore the cwd after pushing | no | true |
| author-name | The name of the user that will be displayed as the author of the commit | no | ${{ github.actor }} |
| author-email | The email of the user that will be displayed as the author of the commit | no | ${{ github.actor }}@users.noreply.github.com |
Outputs
no outputs