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

Update Release Drafter for Dev Branches #387

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

makubacki
Copy link
Member

Changes the way release drafter handles drafting releases on repos with release branches (which have dev branches now).

Ultimately, a release is drafted for the dev branch and the release branch. The releases are 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>

Note that the tag for the release branch follows the same convention as existing release tags.

The "release branch" release includes all pull requests made to the dev branch with the type:backport label since the last "dev branch" release. For this reason, the "dev branch" and "release branch" should be released at the same time. Then, this effectively results in the "release branch" having all relevant changes since the last release. The "dev branch" release will be based at the same point in history as the "release branch" release but include all changes not just those with the type:backport label.

The "release branch" release for the current release branch should be marked as "latest". For example, if "release/202311" and "release/202405" exist, the "release/202405" "release branch" release would be marked as latest.

The release-drafter/release-drafter action is still used.

Changes the way release drafter handles drafting releases on repos
with release branches (which have dev branches now).

Ultimately, a release is drafted for the dev branch and the release
branch. The releases are 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>`

Note that the tag for the release branch follows the same convention
as existing release tags.

The "release branch" release includes all pull requests made to the
dev branch with the `type:backport` label since the last "dev branch"
release. For this reason, the "dev branch" and "release branch"
should be released at the same time. Then, this effectively results
in the "release branch" having all relevant changes since the last
release. The "dev branch" release will be based at the same point in
history as the "release branch" release but include all changes not
just those with the `type:backport` label.

The "release branch" release for the current release branch should be
marked as "latest". For example, if "release/202311" and
"release/202405" exist, the "release/202405" "release branch" release
would be marked as latest.

The `release-drafter/release-drafter` action is still used.

Signed-off-by: Michael Kubacki <[email protected]>
@makubacki makubacki added the type:feature-request A new feature proposal label Nov 18, 2024
@makubacki makubacki self-assigned this Nov 18, 2024
@makubacki makubacki linked an issue Nov 22, 2024 that may be closed by this pull request
@makubacki
Copy link
Member Author

Note: Need to update the change log link at the bottom of the release draft to refer to the correct previous tags:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature-request A new feature proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dev branch support to release drafter
1 participant