Parse and update CHANGELOG.md action
Create a workflow .yml file in your repositories .github/workflows directory. Check Examples below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
| Name | Default | Description |
|---|---|---|
path |
"./CHANGELOG.md" |
Path to CHANGELOG.md file |
release |
"" |
Get or create a release to edit, set it as target |
clear |
false |
Delete everything from target release notes if it exists and not empty |
get |
"" |
Replace target release notes with notes of release provided here, e.g. Undefined
|
set |
"" |
Fully replace target release notes with parameter value |
append |
"" |
Append new lines to target release notes from parameter value |
suffix |
"" |
Add suffix to each section of append notes, good for pasting a link to PR |
save |
true |
Whether to save changes back to CHANGELOG.md path |
sanitize |
false |
Keep only Keep a Changelog sections in target release notes |
encoding |
"utf-8" |
Encoding for CHANGELOG.md
|
| Name | Example | Description |
|---|---|---|
result |
"### Added ..." |
Target Release notes |
label |
"minor" |
Release label based on release notes: major, minor, or patch
|
titles |
"added,removed,fixed" |
Comma-separated Keep a Changelog titles from release notes |
https://github.com/vemel/github_actions_js/
I would love for you to contribute to actions/nextchange, pull requests are welcome! Please see the CONTRIBUTING.md for more information.
The scripts and documentation in this project are released under the MIT License