Fix Versions/Releases & Release Notes - Best practice?

Kim P

Attempting to use the built in Release Notes and need to better understand best practice and a scenario we're facing that feels less than ideal.

Scenario:

We have a bug, fix will be put into multiple Fix Versions

-Version 1a = currently deployed customer version will get a patch today that includes the bug fix

-Version 2 = future version that the code fix will be included in, will be deployed next week to same customers that already have Version 1a - Version 2 will also include additional changes/fixes 

If we put both fix versions on the bug(Version 1a and Version 2) the issue will be included in both sets of release notes.  Realistically, we only need the bug to appear in Version 1a's Release notes as the customer will be exposed to the fix in that version first. 

Are we misusing the Fix Version field? How do we ensure the note isn't in both sets of Release Notes as its ultimately redundant and in my scenario isn't desired in Version 2.

Walter Buggenhout

Hi @Kim P,

To quote the Agile Manifesto : Working software over comprehensive documentation.

Relating this to best practice: Jira's core function is to help you plan and track your work. Not to generate release notes, although it's a nice added benefit that you can do so.

For proper tracking of work: if you identify the hotfix that you are going to deliver to the customer by labelling this as a release, you should identify the issue that needs to be addressed in that release by adding the proper fixversion to it.

If you are going to include the fix in other versions of your software, it is the right thing to do to include that item in that/those version(s) as well. In the end, it is in both versions - no? If not for the release notes, it helps you identify what versions a fix was added to. And if you ever want to search for fixes deployed just in that hotfix release, you'll need to have that information there.

Hope this helps!