telicent-oss/Release Note Extraction
This action extracts release notes for a given version from the Change Log file in the repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| changelog-file | Specifies the Change Log file from which release notes will be extracted. If an empty string is provided then the Change Log release note extraction is skipped. | no | CHANGELOG.md |
| version | Specifies the version for which release notes should be extracted. | yes | — |
| release-notes-file | Specifies the file to which the extracted release notes are written | no | release-notes.txt |
| fail-if-missing | Specifies whether the action should fail if release notes can't be extracted from the Change Log file. Note that this does not have an effect if Change Log release note extraction is disabled by setting `changelog-file` to an empty string. | no | false |
| attach-release-notes | Specifies whether the release notes should be attached to the workflow run as a build artifact using actions/upload-artifact The attached artifact name will include the job name and version by default to distinguish release notes generated by multiple jobs in the same workflow. However, if you are using a matrix job you may also need to set the `attachment-suffix` input to a unique value per matrix job instance. | no | false |
| attachment-suffix | Optional suffix used in generated the artifact name for attaching release notes as artifacts when the `attach-release-notes` input is set to `true`. Should only be needed for matrix jobs where the default artifact name selected is not sufficiently unique. | no | "" |
| job-summary | Specifies whether the release notes that are extracted will be added as a GitHub Job Summary content per https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary | no | true |
Outputs
| name | description |
|---|---|
| release-notes-file | Provides the path to the extracted release notes file. This is identical to the `release-notes-file` input **UNLESS**: - Change log release note extraction was disabled by setting the `changelog-file` input to an empty string - Change log release note extraction failed and `fail-if-missing` was set to `true` |
| release-notes-artifact | Provides the name of the uploaded release notes artifact, this will only exist if the `attach-release-notes` input was set to `true` |
| auto-release-notes | Whether automatic release note generation was detected as being enabled for this repository. |