Skip to content

OBPIH-6388 github action for autogenerating release notes on new tag#4631

Merged
ewaterman merged 2 commits intodevelopfrom
feature/OBPIH-6388-release-notes-automation
May 31, 2024
Merged

OBPIH-6388 github action for autogenerating release notes on new tag#4631
ewaterman merged 2 commits intodevelopfrom
feature/OBPIH-6388-release-notes-automation

Conversation

@ewaterman
Copy link
Member

JIRA Ticket: https://pihemr.atlassian.net/browse/OBPIH-6388

Discovery Document: https://pihemr.atlassian.net/wiki/spaces/OB/pages/3056828417/DISCOVERY%3A+OBPIH-6388+Investigate+new+CI+solution

Adds a new GitHub Action that auto-generates the release notes whenever a new tag is pushed to the repo.

Notes:

  • only runs if the tag starts with "vX.Y.Z" (Ex: 0.9.2, 0.9.2-hotfix...)
  • The action can also be run manually in case it fails for any reason.
  • If the job is re-run, it will replace the existing artifacts in the release

An example of running the Action manually:
Screenshot from 2024-05-20 20-05-49

The release notes that are auto-generated once the action completes:
Screenshot from 2024-05-20 19-16-12

@ewaterman ewaterman requested review from awalkowiak and jmiranda May 21, 2024 00:09
@ewaterman ewaterman self-assigned this May 21, 2024
Copy link
Member

@jmiranda jmiranda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jmiranda
Copy link
Member

@ewaterman As we discussed, you can merge this once you remove the testing part of this.

@ewaterman ewaterman changed the title github action for autogenerating release notes on new tag OBPIH-6388 github action for autogenerating release notes on new tag May 30, 2024
@ewaterman
Copy link
Member Author

I switched this to a new action so that it now displays the PRs correctly:

Screenshot from 2024-05-31 09-42-31

I also removed the test step as mentioned and simplified the Gradle caching step.

A fun bonus of this change is that the release notes can separate our PRs now based on what they're tagged with. I've got an upcoming task to do some automatic PR tagging based on files changed and branch name, so hopefully that will be ready to demo soon!

I'm going to merge as is since this is a low risk change in that we can always delete the release notes that are generated or edit them.

@ewaterman ewaterman merged commit b943f44 into develop May 31, 2024
@ewaterman ewaterman deleted the feature/OBPIH-6388-release-notes-automation branch May 31, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants