devops-center-roadmap icon indicating copy to clipboard operation
devops-center-roadmap copied to clipboard

Name Pull requests on GitHub based on work item Subject

Open john-hutchinson opened this issue 1 year ago • 1 comments

We create Work Items with Subjects and Descriptions then review them in GitHub. However when the PR or 'Review' is sent to GitHub it disregards both summary and description fields and instead uses the WI auto-number which gets difficult to track what each work item is intended to do.

Who/what this helps:

  • Anyone reviewing a PR can know what it is related to.
  • Keeping track of a large number of open PR's as a developer is made easier and more manageable.
  • Creating releases in GitHub will add the merged PR's details to Release notes.
  • Historic read back of the git log will contain clues as to the intention of a merge before inspecting the changed files.

Currently a work item is created like: [DevOps Center] Merge WI-000411 to UAT

It would be great to have it created like: [DevOps Center] Merge WI-000411 to UAT - Survey Flow Changes

Some custom naming syntax settings would be great, but as a minimum just tacking the WI Subject on the end would help greatly.

john-hutchinson avatar Nov 04 '24 14:11 john-hutchinson

100% agree - one of my biggest disappointments with using DOC is that our PR names and therefore release notes are worthless.

richcallear avatar Nov 04 '24 14:11 richcallear