retypeapp/Retype Build Action
Builds documentation using Retype. The output from this step can be published to the hosting of choice.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| output | Custom folder to store the output from the Retype build process. Default is `""` (empty). | no | "" |
| key | Retype Key to unlock Pro features. Your Retype Key is private. Please store your key as a GitHub secret. | no | "" |
| password | Private password used to generate private and protected pages. | no | "" |
| strict | Allows the build to return a non-zero exit code if it encounters any errors or warnings. This can be particularly helpful for developers when they need to validate the stability of their builds. Default is false. | no | false |
| override | JSON configuration overriding project config values. Default is "" (empty). | no | "" |
| verbose | Enable verbose logging during build process. Default is false. | no | false |
| config_path | Path to the retype.yml file. May point to a directory, a JSON or YAML file. If a directory, Retype will look for the 'retype.[yml|yaml|json]' file in this directory. | — | "" |
Outputs
| name | description |
|---|---|
| retype-output-path | Path to the Retype output that can be referenced in other steps within the same workflow. |