Skip to content

Adopt the release-branch publishing model (ADR 0012 + config) #274

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.

Sign up for GitHub

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

Merged
arbrandes merged 2 commits into from
Jul 8, 2026
Merged

Adopt the release-branch publishing model (ADR 0012 + config) #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77d9acc
docs: amend ADR 0012 to publish stable from a release branch
arbrandes Jul 8, 2026
d71bbc3
chore: publish stable from a release branch
arbrandes Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ on:
push:
branches:
- main
- release

permissions:
id-token: write # Required for OIDC
Expand Down
4 changes: 2 additions & 2 deletions .releaserc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"branches": [
"placeholder",
{ "name": "main", "prerelease": "alpha", "channel": "latest" }
{ "name": "release", "channel": "latest" },
{ "name": "main", "prerelease": "alpha" }
],
"tagFormat": "v${version}",
"plugins": [
Expand Down
29 changes: 21 additions & 8 deletions docs/decisions/0012-frontend-branching-strategy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,32 @@ frontend-app-authn@2.0.0-alpha2
3. Creation and publication of release branches
-----------------------------------------------

When the main branch of a given frontend repository contains breaking changes
over the current release and is deemed ready for widespread use, a new "n.x"
branch is cut from it, where "n" is the next major version of the package. The
".x" is literal. For instance:
The current stable codebase is published from a long-lived ``release`` branch.
This branch owns the NPM "latest" dist-tag and is published semantically, with
no breaking changes allowed after publication:

frontend-base@1.0.5
frontend-app-authn@1.4.3

When the main branch contains breaking changes over the current release and is
deemed ready for widespread use, its work graduates onto ``release`` as the next
major. Before that happens, an "n.x" branch is cut from ``release`` to continue
maintaining the outgoing major, where "n" is that major's number and the ".x" is
literal. For instance, when ``release`` moves from the 1.x line to the 2.x line,
a ``1.x`` branch is cut to keep publishing 1.x.y patches:

1.x
2.x

These branches are also published to NPM semantically, with no breaking changes
allowed after publication:
These maintenance branches are also published semantically, with no breaking
changes allowed.

frontend-base@1.0.5
frontend-app-authn@1.4.3
.. note::

We publish the current stable from ``release`` rather than an "n.x" branch
because our release tooling (semantic-release) treats any "N.x"-named branch
as a maintenance branch, which can only patch an already-shipped major, never
originate one. A ``release`` branch has no such restriction.


4. Backports
Expand Down