If you are neck-deep into DevOps using Azure DevOps, chances are that you have your code on a git repository, have PBIs or Stories, are using Pull requests, Builds, and releases. If you are doing all of this good stuff, great! Carry on and I will show you how to get that shiny cherry on top of your cake. If you are not, you can probably benefit from this post too, but you will have to figure out how to do the same using the tools you love.
What I want to do is to automatically generate a markdown file with all work items associated with this release. I also want to accumulate work between environments so work items will only show once on a particular environment.
First, ensure you have a solid branching strategy. I’m quite fond of git flow myself, but anything that uses a PR will work fine.
I really recommend you use PR policies to ensure that everyone is doing the same. This is what I recommend for most projects:
- Require a minimum number of reviewers:
- Check for linked work items. This is key to ensure that release notes are generated
- Check for comment resolution
- Merge Type
- I like squash because it allows the dev to push as many changes as they want but master/develop branch only get a single clean commit
Make sure that your build has the
Automatically link new work in this build flag turned on.
The release notes are generated at the release (duh!) and they will be different from each environment used. You will need an extension to generate the release notes. I use this one by Richad Fennel. Below are the configurations that work well for me:
The template is markdown with some special notation for variables. Review the extension documentation for more information. In my template, I put the work item name and a link back to the azure devops work item. Uncheck the Generate for only this Release flag to ensure that work items associated with builds without releases or not approved releases are accumulated. Here is a copiable version of the template.
The final piece of the puzzle involves publishing your release notes. I recommend having an API endpoint in your app where you can post the release notes. Again, I use powershell to do that:
And here is the powershell code above:
Finally, you can render the uploaded markdown into a html page. Here is what your release notes could look like (style was shamelessly stolen from Visual Studio Code release notes):
That was a lot of little things to consider. However, once you have everything setup, you will never have to write release notes again.