Adds automatic changelog generation when creating a new tagged release
To perform a release: increment the x.y.z value in the VERSION file by some amount as long as it adheres to the x.y.z format, commit and PR, once merged to main the action will fire, creating and pushing a tag in the form: vx.y.z and create a changelog entry of all commit messages matching the given regex pattern, the changelog additions will be in an open PR similar to the index update.
The default regex in the workflow file is (Add|Feat).
Notes:
Currently we assume the user is correctly incrementing the content of VERSION by some amount, no validation is performed on the file contents although error flags will be raised if git commands fail due to bad content
Will fail the first run after the PR merge as it will detect the creation of the VERSION file, rather than a contents change. Once we increment after the PR merge it should be fine
❓ Any adjustment/additions to the (Add|Feat) regex?
To perform a release: increment the
x.y.zvalue in theVERSIONfile by some amount as long as it adheres to thex.y.zformat, commit and PR, once merged tomainthe action will fire, creating and pushing a tag in the form:vx.y.zand create a changelog entry of all commit messages matching the given regex pattern, the changelog additions will be in an open PR similar to the index update.The default regex in the workflow file is
(Add|Feat).Notes:
❓ Any adjustment/additions to the
(Add|Feat)regex?changelog example: https://github.com/jon-funk/rw-public-codecollection/blob/main/CHANGELOG.md action logs: https://github.com/jon-funk/rw-public-codecollection/actions/runs/4558692803 version content: https://github.com/jon-funk/rw-public-codecollection/blob/main/VERSION commit pattern: https://github.com/jon-funk/rw-public-codecollection/commits/main