bengreenier-actions/readme-docs
Upload docs to readme.com
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| apiKey | Your readme.com API Key | yes | — |
| version | Your readme.com project version you wish to upload docs into. See https://docs.readme.com/reference/getproject | yes | — |
| categorySlug | The category slug to upload docs into. See https://docs.readme.com/reference/categories#getcategory | yes | — |
| parentSlug | The parent doc slug (within the category) to upload docs into. See https://docs.readme.com/reference/getdoc | no | "" |
| titlePrefix | The prefix we prepend to each doc title. | no | "" |
| titleRegex | The regex we run for each file to determine the doc title. First capture group is used. | no | #(.+)? |
| path | The file path(s) to upload. Globs supported. See https://github.com/actions/toolkit/tree/main/packages/glob | no | "" |
| additionalJson | Json string to base requests off of. Overridden by other action inputs. See https://docs.readme.com/reference/getdoc | no | {} |
| create | Flag indicating if we should create new docs. See https://docs.readme.com/reference/createdoc | no | true |
| overwrite | Flag indicating if we should overwrite existing docs. See https://docs.readme.com/reference/updatedoc | no | false |
| clear | Flag indicating if we should clear the category of docs before creation. See https://docs.readme.com/reference/deletedoc | no | false |
Outputs
no outputs