{"repo":"stefanzweifel/changelog-updater-action","free":true,"listed":false,"github":"https://github.com/stefanzweifel/changelog-updater-action","clone":"git clone https://github.com/stefanzweifel/changelog-updater-action.git","description":"A GitHub Action to automatically update a \"Keep a Changelog\" CHANGELOG with the latest release notes.","language":"Shell","stars":157,"topics":["github-actions","changelog","keep-a-changelog","actions","automation","github"],"license":"MIT","category":"workflow-automation","readme_excerpt":"changelog-updater Action A GitHub Action to update a changelog with the latest release notes. The Action … - adds a new second level heading for the new release - pastes your release notes in the appropriate place in CHANGELOG.md If your changelog follows the \"Keep a Changelog\" format and contains an \"Unreleased\"-heading, the Action will update the heading to point to the compare view between the latest version and HEAD . (Read more about this here) Don't want to use GitHub Actions? Checkout the changelog-updater CLI that powers this Action. Want to learn more about this Action? Read my introduction blog post. Usage The Action is best used in a Workflow that listens to the release -event and the type released . This way, the name and body of your release will be added to the CHANGELOG. The following is an example Workflow ready to be used. The Workflow checks out the target branch of the release, updates the ./CHANGELOG.md -file with the name and the contents of the just released release and commits the changes back to your repository using git-auto-commit. To generate the release notes automatically for you, I can recommend using the release-drafter Action. Note When you use the publish -input of release-drafter to immediately create the release, the release -event is probably not triggered due to a limitation of GitHub Actions. Please create a personal access token, add it as a secret to your repository and pass the token to the release-drafter/release-drafter -Action. See ","default_branch":null,"files":null,"tree":[],"storefront":"/r/stefanzweifel","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/stefanzweifel/changelog-updater-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}