[OBPIH-6479, OBPIH-6483] PR labeler, PR template description#4687
[OBPIH-6479, OBPIH-6483] PR labeler, PR template description#4687
Conversation
| @@ -3,21 +3,32 @@ | |||
| changelog: | |||
There was a problem hiding this comment.
This is for when we generate our release notes. It'll split the commits into sections based on the labels that were on their PRs.
It was already existing from a previous PR so I just fixed it to support the updated labels.
| @@ -0,0 +1,32 @@ | |||
| ### :sparkles: Description of Change | |||
There was a problem hiding this comment.
This template will be auto-generated for every new PR. Feel free to suggest other things to add but maybe we can review it as a team in a tech huddle. I just wanted to have something for now
|
Look good to me! 🚀 |
|
@drodzewicz Yeah that would be useful. I'd definitely like for it to be automatic since I don't want people to have to remember both what version we're on and also to add the label. Maybe we could create a GitHub Action that pulls the I do know that GitHub has milestones, which is essentially like releases. I see we've used them before #4395. Maybe something we could consider again. |
|
Yeah that's a great idea @drodzewicz and something I hadn't thought of for PRs. @ewaterman milestones is definitely the way to go there. I used them a bit with issues but never really considered it for PRs since we can trace back to the release using the ticket. It would be great to use milestones on PRs but one thing that might be surprisingly difficult is keeping the milestone for a PR in sync with the Jira fixVersion. |
|
I'd like to handle release/milestone labelling in a separate PR. I imagine that will require some thought since we're not really utilizing milestones right now. I do like the idea of associating PRs to releases, it'll just require some investigation. Also for reference, this is what the current PR template looks like: |

This is a low-priority change so feel free to take your time reviewing it.
Tickets: https://pihemr.atlassian.net/browse/OBPIH-6483 https://pihemr.atlassian.net/browse/OBPIH-6479
Background info: https://pihemr.atlassian.net/wiki/spaces/OB/pages/3066658817/DISCOVERY+OBPIH-6376+Standardize+GitHub+branching+practices#Pull-Request-Rules
Added a new GitHub action for automatically labelling a pull request based on the branch name and what files are changed. You can see some of the labels being automatically applied in this PR.
The goal is to be able to determine the type of change made by a PR just by looking at its labels. This will hopefully make reviewing easier in that we can filter reviews by things like frontend/backend and also will make searching for reviews, discussions, and issues easier. We can add more labels in the future if we want.
I also added a pull request template
pull_request_template.mdthat will auto fill for every new PR. That way we can ensure all PRs are clearly describing their changes and are following our code guidelines