Add release notes as comments
See original GitHub issueWould be nice if the extension allowed to save release notes of the dependencies as PR comments. I see 2 advantages of the switch:
- Work items wouldn’t automatically be mentioned by the merge commit. If the release note contains Azure’s
#1234
ticket linking syntax, the accidentally mentioned ticket number could conflict with other automations, like Work Item Updater or the built-in auto-close feature. - When updating by multiple versions, it could allow seperate validation of the changes comment-by-comment. Commit description could still be explicitly edited.
My pain point is 1. and I’m open to other suggestions and to help with the implementation.
Issue Analytics
- State:
- Created 6 months ago
- Comments:6 (3 by maintainers)
Top Results From Across the Web
Create release notes
Use this field to add custom release notes to the issues in your version. Navigate to your version and select Release notes, then...
Read more >Automatically generated release notes
Creating automatically generated release notes for a new release · Select Create a discussion for this release. · Select the Category dropdown menu,...
Read more >How to write release notes (template +5 great examples)
A release note is a report published alongside new or updated software that details the technical features of the product. For new releases,...
Read more >Creating a custom Release Notes template containing ...
In this step you add a custom field for your release note comments. Note that you'll be associating this custom field with a...
Read more >Adding Release Notes
Write your release notes in the past tense. For example, use “Added” instead of “Add”, “Fixed” instead of “Fix”, and “Updated” instead of...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
For the tools to not be linked to work items, I believe you would need to change the logic for generating the description to strip out special character sequences. It is easier than writing the changes in comments. Unfortunately, I do not have the time to do this but you can give it a shot.
Thanks for your time and the details, however, I have a custom automation set up that modifies tasks in a custom pipeline, and I’m not using the built-in functionality to close them automatically. This process picks up the tasks linked to the pipeline itself:
The work items can get linked multiple ways AFAIK, but what I want to avoid when using debendabot is to have no extra work item referenced accidentally. If the release notes contain a link to an issue/pr on github (for example:
then, the issue #5806 from my own project might be mentioned in the merge commit, if I forget to change the PR’s description.
Sorry for not being clear enough.