Hey everyone,
I’m working on automating the creation of release notes for my project. My idea is to pull closed Jira tickets and use them to generate a readme.txt or release.txt file.
I’m wondering if there’s a way to fetch all closed tickets for a specific project, starting from a given ticket ID. I’m thinking of doing this either in my nant script or directly in C# code.
Is this a good approach? Or are there better ways to handle this kind of task? I’d love to hear your thoughts and experiences on automating release notes from Jira data.
Also, if anyone has suggestions for .NET libraries or APIs that might help with this, I’m all ears!
Thanks in advance for your help!
I’ve implemented a similar solution in my workplace. We use the Jira REST API directly with HttpClient in .NET. It’s quite flexible and allows us to customize our queries extensively. We fetch tickets based on a specific version or date range, then parse the JSON responses to extract relevant information. For formatting, we use a simple template system with placeholders. This approach has worked well for us, providing detailed and accurate release notes with minimal manual intervention. One tip: consider caching API responses to improve performance if you’re dealing with a large number of tickets.
I’ve found that integrating Jira with our CI/CD pipeline has been a game-changer for generating release notes. We use Azure DevOps, and we’ve set up a custom task that queries Jira at build time. It pulls in all resolved issues for the current sprint, categorizes them (bug fixes, new features, etc.), and formats them into a structured markdown file.
One thing we learned the hard way: make sure your Jira ticket titles and descriptions are clear and concise. They often end up verbatim in the release notes, so training the team to write good ticket descriptions pays off big time.
Also, consider implementing a tagging system in Jira for items you specifically want in (or out of) the release notes. It gives you more fine-grained control over what gets included without having to manually edit the output every time.
hey mate, i’ve tackled this before. You can use Atlassian.SDK NuGet package to connect to Jira API. Fetch tickets using JQL queries, then process the data to generate notes. It’s pretty straightforward once you get the hang of it. good luck with ur project!