Skip to content

build: create separate release branches for tagged releases on publish#457

Merged
zimeg merged 6 commits intoslackapi:mainfrom
zimeg:main
Jun 13, 2025
Merged

build: create separate release branches for tagged releases on publish#457
zimeg merged 6 commits intoslackapi:mainfrom
zimeg:main

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Jun 11, 2025

Summary

This PR creates separate release branches for tagged releases from the changes on main to avoid appearances of the confusing "imposter commit". Fixes #444.

Preview

Release candidates with these attempted changes can be found from a fork:

Notice that zimeg@9dd078e is part of the v2.1.1-rc.6 release branch while an earlier commit for v2.1.1-rc.1 is shown as zimeg@9185572 and contains the warning:

⚠️ This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Notes

The release branch pattern is of course open for discussion! But for fast reference it appears as:

  • release/v2.1.0
  • release/v2.1.1-rc.1
  • release/v2.1.1
  • release/v2.2.0

Separate branches are preferred to including the packaged distribution on main and are also required since tags do not share direct histories:

*-----*-----*-----*-----*-----*-----*-----*-----* (main)
 \                 \                       \
  *                 *                       *
  v2.0.0            v2.1.0-rc1              v2.1.0
  v2.0                                      v2.1
                                            v2

 (release/v2.0.0)  (release/v2.1.0-rc.1)   (release/v2.1.0)

📣 If these changes seem alright I plan to create similar release branches for releases since @v2!

Requirements

@zimeg zimeg added this to the 2.2 milestone Jun 11, 2025
@zimeg zimeg self-assigned this Jun 11, 2025
@zimeg zimeg added security semver:patch github_actions Pull requests that update GitHub Actions code labels Jun 11, 2025
@codecov
Copy link

codecov bot commented Jun 11, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.86%. Comparing base (a3c435b) to head (d2afcd7).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #457   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files           7        7           
  Lines         722      722           
=======================================
  Hits          721      721           
  Misses          1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mwbrooks
mwbrooks approved these changes Jun 11, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Looking good to me and your suggested versioning pattern looks like what I'd expect! :shipit:

.github/workflows/publish.yml
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
fetch-depth: 0
Copy link
Member

@mwbrooks mwbrooks Jun 11, 2025

Choose a reason for hiding this comment

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

praise: Optimization! 🚗💨

WilliamBergamin
WilliamBergamin approved these changes Jun 12, 2025
View reviewed changes
Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

This looks good 💯 should we also add something in the maintainers_guide?

@zimeg
Copy link
Member Author

zimeg commented Jun 13, 2025

@mwbrooks @WilliamBergamin Thanks for both the reviews and reminder of noting these patterns in documentation with d2afcd7: 🙏 ✨

release/vX.Y.Z has the packaged distribution of a particular version based from the changes on main. This is created using a workflow when new releases are published.

Since we don't recommend using branches in actual workflows I'll avoid adding similar notes to public documentation, but that might be possible after this change 🔍

For now I'll merge this PR and backfill branches for existing tags since @v2 but am also going to hold off on the next release - I'm excited to watch this run soon! 🤖

@zimeg zimeg merged commit 82b86fb into slackapi:main Jun 13, 2025
5 checks passed
This was referenced Jul 9, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

@WilliamBergamin WilliamBergamin WilliamBergamin approved these changes

@hello-ashleyintech hello-ashleyintech Awaiting requested review from hello-ashleyintech

Assignees

@zimeg zimeg

Labels

github_actions Pull requests that update GitHub Actions code security semver:patch

Projects

None yet

Milestone

2.1.1

Development

Successfully merging this pull request may close these issues.

Commit of Release v2.0.0 does not belong to any branch on this repository

3 participants

@zimeg @mwbrooks @WilliamBergamin

Comments