Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Tags to XPlat Release Notes #426

Closed
rfennell opened this Issue Feb 2, 2019 · 6 comments

Comments

3 participants
@rfennell
Copy link
Owner

rfennell commented Feb 2, 2019

Azure DevOps Extension you are using

Change for XPlat Release Notes for ALM Rangers

Add a tag condition to the @@WILOOP@@, for example in the template below we extract description for work item(s) tagged with RELEASENOTE and then BUSINESSVALUE, followed by a list of all the work items.

Something like

# Release notes
## Notes for release  ${releaseDetails.releaseDefinition.name}
**Release Number**  : ${releaseDetails.name}
**Release completed** : ${releaseDetails.modifiedOn}
**Compared Release Number**  : ${compareReleaseDetails.name}
 
### RELEASE NOTES
@@WILOOP-RELEASENOTE@@
${widetail.fields['System.Description']}
@@WILOOP-RELEASENOTE@@
 
### BUSINES VALUE
@@WILOOP-BUSINESSVALUE@@
${widetail.fields['System.Description']}
@@WILOOP-BUSINESSVALUE@@
 
---
 
### Associated work items
@@WILOOP@@
* ** ${widetail.fields['System.WorkItemType']} ${widetail.id} ** Assigned by: ${widetail.fields['System.AssignedTo']}  ${widetail.fields['System.Title']}
@@WILOOP@@
 
### Associated commits
@@CSLOOP@@
* **ID ${csdetail.id} ** ${csdetail.message}
@@CSLOOP@@

@rfennell rfennell self-assigned this Feb 2, 2019

@rfennell rfennell added this to To do in GenerateReleaseNotes (Xplat version) via automation Feb 2, 2019

@rfennell rfennell changed the title Added Tags to XPlat Release Nots Added Tags to XPlat Release Notes Feb 2, 2019

@wpschaub

This comment has been minimized.

Copy link

wpschaub commented Feb 2, 2019

Thanks for adding this issue @rfennell. This will allow us to generate release notes that are valuable to business and engineering. Let me know when and how we can help.

@rfennell

This comment has been minimized.

Copy link
Owner Author

rfennell commented Feb 4, 2019

@wpschaub Is this format OK for your needs

@@WILOOP:RELEASENOTE:BUSINESS VALUE@@
${widetail.fields['System.Description']}
@@WILOOP:RELEASENOTE:BUSINESS VALUE@@

It allows

  • Multiple tags
  • They can have spaces in them
  • I would use them in an AND when selecting WI

Do you think : (colon) is a reasonable delimiter, I am erring towards making it configurable as a parameter, someone is bound to have used : in a tag

Thoughts?

@wpschaub

This comment has been minimized.

Copy link

wpschaub commented Feb 4, 2019

Multiple tags assuming an AND condition is making this an even more powerful feature :)
We're not using : in tags, but others may. How about defaulting to ; (semicolon) or | (vertical slash)?

@ChrisLGardner

This comment has been minimized.

Copy link
Collaborator

ChrisLGardner commented Feb 4, 2019

Perhaps have a toggle to make it swap to OR instead of AND? Or go for a regex style approach with ; being for AND then | for OR?

That would let you end up with statements like:

@@WILOOP(RELEASENOTE;(BUSINESS VALUE|IMPORTANT NOTE))@@

@rfennell

This comment has been minimized.

Copy link
Owner Author

rfennell commented Feb 4, 2019

@ChrisLGardner AND/OR I think is for V-future, lets get this working first

@rfennell

This comment has been minimized.

Copy link
Owner Author

rfennell commented Feb 14, 2019

Shipped in 2.7.10

@rfennell rfennell closed this Feb 14, 2019

GenerateReleaseNotes (Xplat version) automation moved this from To do to Done Feb 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.