{"repo":"Decathlon/release-notes-generator-action","free":true,"listed":false,"github":"https://github.com/Decathlon/release-notes-generator-action","clone":"git clone https://github.com/Decathlon/release-notes-generator-action.git","description":"Action to auto generate a release note based on your events","language":"Shell","stars":125,"topics":["github-actions","release-note","spring"],"license":"Apache-2.0","category":"productivity","readme_excerpt":"Release Note Generator GitHub Action This repository provides a GitHub action to automatically create a release notes when a milestone is closed. Table of Contents - Common usage - Why? - Startup - Use GitHub action - Settings for v2.0.0+ release - NOTE - Result illustration - Configure output folder - Custom output release file - Prefixed name using v2.0.0+ - Use Milestone title - Prefixed name using v2.0.0+ - Result illustration - How to use the generated file Common usage Each time a milestone is closed, this GitHub action scans its attached issues and pull request, and automatically generates a wonderful release note. The action uses Spring.io changelog generator tool. Why? Why aren't we simply automating the release creation and push the release notes there? We think in some cases it is better to keep release notes separated from the release process... yeah, maybe the right name is not release notes anymore. :) Taking as example a continuous deployment project: anytime you push to the repository, a new version of the application is built and pushed in production. And so, a new release is created to complete the process; a release with a single feature inside. We think it is not a good idea to push to 'users' a new release notes message every time you generate a changes in the source code (let us say 10 times a day?). It may be a better way to communicate only once every week or once the sprint is over, which gives you a clearer and complete release notes containing the a","default_branch":null,"files":null,"tree":[],"storefront":"/r/Decathlon","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Decathlon/release-notes-generator-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."}