You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Open PR against RELEASE_ISSUE_TEMPLATE.md with title docs(release): v1.2.3 release template improvements for improving future releases.
Link to PR:
There likely aren't any changes at this point, but this can be opened with a small whitespace change so the PR is open and we can more easily hold the standard of making improvements incrementally since improvements are usually better done by collecting changes/notes along the way rather than just thinking about it at the end.
This will get merged in a Post Release step.
(patch release) Fork a new branch (release/v1.2.3 or release/miner/v1.2.3) from the last stable release/vX.Y.x or release/miner/vX.Y.x and make any further release-related changes to this branch.
master branch Version string updates
Skip this set of steps if you are patching a previous minor release.
bump the version(s) in build/version.go to v1.2.4-dev.
Ensure to update the appropriate version string based on whether you are creating a node release (NodeBuildVersion), a miner release (MinerBuildVersion), or both.
Run make gen && make docsgen-cli before committing changes.
Update the CHANGELOG
Change the UNRELEASED section header to UNRELEASED v1.2.3
Removed the "backport" label from all backported PRs (no "backport" issues)
Create a PR with title build: backport changes for node v1.2.3-rcX
Link to PR:
Merge PR
Release PR
Update the version string(s) in build/version.go to one ending with '-rcX'.
Ensure to update the appropriate version string based on whether you are creating a node release (NodeBuildVersion), a miner release (MinerBuildVersion), or both.
Run make gen && make docsgen-cli to generate documentation
Create a draft PR with title build: release Lotus node v1.2.3-rcX
Link to PR:
Opening a PR will trigger a CI run that will build assets, create a draft GitHub release, and attach the assets.
Changelog prep
Go to the releases page and copy the auto-generated release notes into the CHANGELOG
Perform editorial review (e.g., callout breaking changes, new features, FIPs, actor bundles)
(network upgrade) Specify whether the Calibration or Mainnet upgrade epoch has been specified or not yet.
Example where these weren't specified yet: PR #12169
Ensure no missing content when spot checking git history
Example command looking at git commits: git log --oneline --graph vA.B.C.., where A.B.C correspond to the previous release.
Example gh cli command looking at merged PRs into master and sorted by title to group similar areas (where YYYY-MM-DD is the start search date): gh pr list --repo filecoin-project/lotus --search "base:master merged:>YYYY-MM-DD" --json number,mergedAt,author,title | jq -r '.[] | [.number, .mergedAt, .author.login, .title] | @tsv' | sort -k4
Update the PR with the commit(s) made to the CHANGELOG
Mark the PR "ready for review" (non-draft)
Merge the PR
Merging the PR will trigger a CI run that will build assets, attach the assets to the GitHub release, publish the GitHub release, and create the corresponding git tag.
Update 🚢 Estimated shipping date table
Comment on this issue announcing the RC
Link to issue comment:
Testing
Note
Link to any special steps for testing releases beyond ensuring CI is green. Steps can be inlined here or tracked elsewhere.
Stable (non-RC) Release
Note
1️⃣ Copy/paste in the rcX section above to below this [!Note]
2️⃣ make these changes:
Release PR > Update the version string...
Update the version string in build/version.go to one NOT ending with '-rcX'
Release PR > Changelog prep...
Add "(network upgrade) Ensure the Mainnet upgrade epoch is specified."
Release PR > Create a draft PR...
Create a PR with title build: release Lotus node v1.2.3
3️⃣ Remove this [!Note] and the related invisible comments.
Post-Release
Open a PR against master cherry-picking the CHANGELOG commits from the release/v1.2.3 branch. Title it chore(release): cherry-pick v1.2.3 changelog back to master
Lotus node 1.2.3 Release
😶🌫 Meta
Scope: node patch
(network upgrade) This release is related to a network upgrade and thus mandatory.
(network upgrade) Related network upgrade version: nv23
🚢 Estimated shipping date
🪢 Dependencies for releases
Note
master
.Release Checklist
.rcX
Stable (non-RC)
✅ Release Checklist
Before RC1
(network upgrade) Make sure all Lotus dependencies are updated to the correct versions for the network upgrade
Open PR against RELEASE_ISSUE_TEMPLATE.md with title
docs(release): v1.2.3 release template improvements
for improving future releases.Post Release
step.(patch release) Fork a new branch (
release/v1.2.3
orrelease/miner/v1.2.3
) from the last stablerelease/vX.Y.x
orrelease/miner/vX.Y.x
and make any further release-related changes to this branch.master
branch Version string updatesbuild/version.go
tov1.2.4-dev
.NodeBuildVersion
), a miner release (MinerBuildVersion
), or both.make gen && make docsgen-cli
before committing changes.UNRELEASED
section header toUNRELEASED v1.2.3
UNRELEASED v1.2.3
section's content to be "See https://github.com/filecoin-project/lotus/blob/release/v1.2.3/CHANGELOG.md"UNRELEASED
header to top.build: update Lotus node version to v1.2.4-dev in master
RCs
rcX
Important
These PRs should be done in and target the
release/v1.2.3
orrelease/miner/v1.2.3
branch.Backport PR
Dependencies for releases
have landedbuild: backport changes for node v1.2.3-rcX
Release PR
build/version.go
to one ending with '-rcX'.NodeBuildVersion
), a miner release (MinerBuildVersion
), or both.make gen && make docsgen-cli
to generate documentationbuild: release Lotus node v1.2.3-rcX
Go to the releases page and copy the auto-generated release notes into the CHANGELOG
Perform editorial review (e.g., callout breaking changes, new features, FIPs, actor bundles)
(network upgrade) Specify whether the Calibration or Mainnet upgrade epoch has been specified or not yet.
Ensure no missing content when spot checking git history
git log --oneline --graph vA.B.C..
, where A.B.C correspond to the previous release.gh
cli command looking at merged PRs into master and sorted by title to group similar areas (whereYYYY-MM-DD
is the start search date):gh pr list --repo filecoin-project/lotus --search "base:master merged:>YYYY-MM-DD" --json number,mergedAt,author,title | jq -r '.[] | [.number, .mergedAt, .author.login, .title] | @tsv' | sort -k4
Update the PR with the commit(s) made to the CHANGELOG
🚢 Estimated shipping date
tableTesting
Note
Link to any special steps for testing releases beyond ensuring CI is green. Steps can be inlined here or tracked elsewhere.
Stable (non-RC) Release
Note
1️⃣ Copy/paste in the
rcX
section above to below this[!Note]
2️⃣ make these changes:
build/version.go
to one NOT ending with '-rcX'build: release Lotus node v1.2.3
3️⃣ Remove this
[!Note]
and the related invisible comments.Post-Release
master
cherry-picking the CHANGELOG commits from therelease/v1.2.3
branch. Title itchore(release): cherry-pick v1.2.3 changelog back to master
master
first before backporting to the release branch, the only changes should be CHANGELOG updates.Before RC1
with any improvements determined from this latest release iteration.❤️ Contributors
See the final release notes!
Leave a comment in this ticket!
The text was updated successfully, but these errors were encountered: