mpaperno/Extract Release Notes
Extract release notes from a CHANGELOG file.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version_tag | The version tag to look for, as it appears in headings (eg. "v1.2.3-beta2"), or "latest" (default) to get the latest notes. The tag is expected to be on a heading line with one or more leading "#" signs followed by a space. The heading level to look for can be set in the `heading_level` argument. | no | latest |
| changelog_file | The input path of the changelog file. Default: `./CHANGELOG.md` | no | ./CHANGELOG.md |
| heading_level | The heading level (number of "#") marking each new version description. Default is 2. | no | 2 |
| changelog_ascending | Specify that the change log shows changes in ascending order, newest version at end. Default is false, latest release at top. | no | false |
| fallback_to_latest | Fall back to getting the latest version release notes if a block which matches "version_tag" is not found. Default is false. | no | false |
| output_file | An optional file path/name to write the extracted title and release notes to. | no | "" |
Outputs
| name | description |
|---|---|
| release_title | The full heading line with version number. The leading heading marks ("#") will be stripped and the result trimmed. |
| release_notes | The release notes body for found version. |