pantheon-systems/Generate Release Note
Automated release note generation. This action will generate a docs release note from the GitHub release note and create a pull request in the docs repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | A GitHub Personal Access Token with access to the Documentation repository. | yes | — |
| categories | Comma-separated list of categories for the release note. For a complete list of categories and descriptions, see https://github.com/pantheon-systems/documentation/blob/main/source/releasenotescategories/releaseNoteCategories.json | yes | — |
| docs_repo | The documentation repository to create the pull request. (Optional, included for testing against forked repositories.) Must be in <vendor>/<repository> format. | no | pantheon-systems/documentation |
| repo_name | The repository or project name. Used to create the human-readable repository name (rather than the repo slug). Optional but recommended. | no | — |
| template_file | Custom release note template file. Should be stored in your .github/workflows/ folder. | no | — |
| release_note_only_uses_template | Whether the release note should only use the template or to combine the release note template (via template_file) with the actual release notes from the release. Defaults to combine both. | no | false |
| release_body_override | Override the release body with a customized message. Can be used to generate release note copy dynamically in a previous step and saved to an environment variable. Can be used with `release_note_only_uses_template: true` to only use the template and/or the release body and drop the notes from the release. | no | — |
Outputs
no outputs