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

Add dev branch support to release drafter #388

Open
makubacki opened this issue Nov 22, 2024 · 0 comments · May be fixed by #387
Open

Add dev branch support to release drafter #388

makubacki opened this issue Nov 22, 2024 · 0 comments · May be fixed by #387
Assignees
Labels
type:design-change A new proposal or modification to a feature design type:feature-request A new feature proposal

Comments

@makubacki
Copy link
Member

Current Issue

The release-drafter/release-drafter GitHub action is used to apply semantic versioning to releases automatically drafted with categorized changes based on labels in the relevant pull requests to the release.

With the move to dev branches, the release drafter as it is currently implemented does not work. The release branch no longer has direct pull requests but instead changes automatically cherry-picked from its corresponding dev branch. This means there are no PRs in the release branch to base the release information on.


Proposed Change

All changes to a release branch should occur by the PR into the dev branch having the type:backport label. Therefore, a list of release branch changes can be built off that information. However, the action needs to run against the dev branch to get that which means the dev branch also needs a release point. So, both the dev and release branches need a release and both releases should occur at the same time so the information from the last release branch release is consistent.

The releases should be differentiated by both their release title and tag.

  • Release Branch
    • Title: release-v<version>
    • Tag: v<version>
  • Dev Branch
    • Title: dev-v<version>
    • Tag: dev-v<version>

This keeps the release branch tag consistent with the tag used today. The titles differentiate the releases in GitHub.

When making a release in GitHub, the dev branch release should be made first and then the corresponding release branch release. The release branch release for the latest release branch (e.g. 202405) should be marked as latest so it is obvious to a consumer what is the latest release for the latest Mu branch in the repo.

@makubacki makubacki added type:design-change A new proposal or modification to a feature design type:feature-request A new feature proposal labels Nov 22, 2024
@makubacki makubacki self-assigned this Nov 22, 2024
@makubacki makubacki linked a pull request Nov 22, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:design-change A new proposal or modification to a feature design type:feature-request A new feature proposal
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant