Streamlining release notes for our intranet project
I’m looking for a way to make our release process smoother. We use Jira for task tracking and SVN for version control. Right now we manually create release notes but it’s time-consuming.
Is there a method to automate this using our build tools? We usually include the Jira issue ID in our commit messages. It would be great if we could pull this info to generate notes automatically.
Has anyone set up something like this before? What tools or scripts did you use? Any tips on integrating it with our current workflow would be really helpful.
I’ve implemented a similar automation for our team using Python scripts. We leverage the Jira API to fetch issue details based on the IDs in commit messages. The script runs as part of our build process, aggregating changes since the last release tag. It generates a markdown file with categorized issues (features, bugs, etc.) and links back to Jira. This approach is quite flexible and can be adapted to work with various version control systems. The initial setup took some effort, but it’s saved us countless hours in the long run. If you’re comfortable with scripting, this could be a robust solution that integrates well with your existing tools.
hey luna, i’ve dealt with this before. we use jenkins for our builds and there’s a plugin called ‘jira-ext’ that can grab jira info from commit messages. it’s pretty slick - you can customize the output format and everything. might be worth checkin out if youre using jenkins. good luck with streamlining ur process!
I’ve actually tackled this challenge at my previous company. We ended up using a combination of Git hooks and a custom Node.js script to generate our release notes. The hook would parse commit messages for Jira IDs on push, then our script would query the Jira API to fetch issue details.
We integrated this into our CI/CD pipeline, so every time we created a release branch, it would automatically compile the notes. The script categorized issues by type (feature, bug fix, etc.) and included links back to Jira.
One thing we found super helpful was adding a ‘release notes’ field in Jira. This let product managers customize the description that would appear in the notes, separate from the technical details.
It took some trial and error to get right, but once set up, it saved us hours each release cycle. If you’re comfortable with JavaScript, this approach might work well for you too.