@@ -6,24 +6,30 @@ GitHub Actions, and Roam Depot.
66## Release Tracking Model
77
88Roam uses a scheduled Linear release pipeline. At any time, there should be one
9- active Roam release collecting new work and, after a release is completed, a new
10- release should be created manually for the next version.
9+ active Roam release collecting new work. After a release is submitted to Roam for
10+ review, that release is frozen and a new release should be created manually for
11+ the next version.
1112
12- After a release is marked ` Released ` in Linear:
13+ After the ` roam-release.yaml ` workflow moves a release to
14+ ` Sent to Roam for Review ` in Linear:
1315
14161 . Create the next Roam release manually in the Roam Linear release pipeline.
15172 . Use the next version number, such as ` 0.20.0 ` .
16183 . Move that new Linear release to ` In Progress ` .
19+ 4 . Bump ` apps/roam/package.json ` to that next version in a follow-up PR.
1720
18- Once the next release is in progress, the ` roam-main.yaml ` workflow automatically
19- syncs eligible merged work into that release when commits land on ` main ` and
20- touch Roam-related paths such as ` apps/roam/** ` .
21+ The post-submission package bump must happen after ` roam-release.yaml ` runs,
22+ because that workflow reads ` apps/roam/package.json ` for the version being sent
23+ to Roam. Once the next release is in progress and the package version has been
24+ bumped, the ` roam-main.yaml ` workflow automatically syncs eligible merged work
25+ into that release when commits land on ` main ` and touch Roam-related paths such
26+ as ` apps/roam/** ` .
2127
2228## Preparing Release Notes
2329
2430Before publishing a Roam release:
2531
26- 1 . Bump ` apps/roam/package.json ` to the release version.
32+ 1 . Bump ` apps/roam/package.json ` to the release version being submitted .
27332 . Create a PR for that version bump.
28343 . Generate release notes from the Linear release. The Linear Agent can generate
2935 these from the issues included in the Linear release.
@@ -52,7 +58,11 @@ When the version bump and changelog are merged:
52582 . Confirm the workflow succeeds.
53593 . The workflow updates Roam Depot metadata and moves the Linear release to
5460 ` Sent to Roam for Review ` .
55- 4 . Cut the Roam Depot PR to Roam.
61+ 4 . Treat the release as frozen in Linear.
62+ 5 . Create the next Roam Linear release, move it to ` In Progress ` , and bump
63+ ` apps/roam/package.json ` to that next version in a follow-up PR. This keeps
64+ the alpha branch and release metadata aligned with the active release line.
65+ 6 . Cut the Roam Depot PR to Roam.
5666
5767At this point the release is submitted for Roam review, but it is not finished.
5868
@@ -64,11 +74,13 @@ After the Roam Depot PR is merged by Roam:
64742 . Change the Linear release from ` Sent to Roam for Review ` to ` Released ` .
65753 . If using the manual completion workflow, run ` Complete Roam Linear Release `
6676 (` .github/workflows/roam-release-complete.yaml ` ) with the release version.
67- 4 . Immediately create the next Linear release at the next version number and
68- move it to ` In Progress ` .
77+ 4 . Confirm the next Linear release is already ` In Progress ` and
78+ ` apps/roam/package.json ` is already bumped to that next version .
6979
70- Creating the next in-progress Linear release is required so future Roam commits
71- can be collected automatically by ` roam-main.yaml ` .
80+ Creating the next in-progress Linear release and bumping the Roam package version
81+ after submission is required so future Roam commits can be collected
82+ automatically by ` roam-main.yaml ` and reflected with the correct alpha/release
83+ version.
7284
7385## Workflow Responsibilities
7486
0 commit comments