marcoreni/Docs publisher
Takes care of publishing documentation to the specified branch
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| deployment-branch | The branch where the docs will be published | yes | gh-pages |
| docs-command | The command to be run inside the repository to create the docs | yes | — |
| docs-path | The path where documentation will be found once docs are created. Path is relative to the root of the project | yes | — |
| token | Used to work with git. Since there's a default, this is typically not supplied by the user. | yes | ${{ github.token }} |
| strategy | The strategy to use to fetch the version. Currently, "tag" and "lerna" are supported. | yes | tag |
| versions-sorting | The strategy to use to sort the versions in the list. Possible values: - `semver-desc`: sorts by semver descending. - `semver-asc`: sorts by semver ascending. - `timestamp-desc`: sorts by release timestamp (based on the run that generated a specific build) descending. - `timestamp-asc`: sorts by release timestamp (based on the run that generated a specific build) ascending. | yes | timestamp-desc |
| enable-prereleases | Split the versions list into two separate lists of releases and prereleases, using `semver`. | yes | false |
Outputs
no outputs