-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Closed
Labels
Description
πΆβπ« Meta
- Type: Node
- Level: patch
- Related network upgrade version: n/a
π’ Estimated shipping date
Candidate | Expected Release Date | Release URL |
---|---|---|
RC1 | 2025-01-21 | https://github.com/filecoin-project/lotus/releases/tag/v1.31.1-rc1 |
Stable (non-RC) | 2025-01-27 | https://github.com/filecoin-project/lotus/releases/tag/v1.31.1 |
πͺ’ Dependencies for releases
Note
- This is the set of changes that need to make it in for a given RC. This is effectively the set of changes to cherry-pick from master.
- They can be checked as done once they land in
master
. - They are presented here for quick reference, but backporting is tracked in each
Release Checklist
.
rc1
None
Stable Release (non-RC)
None
β Release Checklist
β¬ οΈ Before RC1
Section
- Open PR against RELEASE_ISSUE_TEMPLATE.md with title
docs(release): v1.31.1 release template improvements
for improving future releases.- Link to PR: docs(release): v1.30.0, v1.31.0 and v1.31.1 release template improvementsΒ #12563
- 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.
- Fork a new
release/v1.31.1
branch from themaster
branch and make any further release-related changes to this branch.- Note: For critical security patches, fork a new branch from the last stable
release/vX.Y.x
to expedite the release process.
- Note: For critical security patches, fork a new branch from the last stable
ποΈ RCs
rc1
Section
[!IMPORTANT]
These PRs should be done in and target therelease/v1.31.1
orrelease/miner/v1.31.1
branch.
Backport PR for rc1
- All explicitly tracked items from
Dependencies for releases
have landed
Release PR for rc1
- Update the version string(s) in
build/version.go
to one ending with '-rc1'.- Ensure to update
NodeBuildVersion
- Ensure to update
- Run
make gen && make docsgen-cli
to generate documentation - Create a draft PR with title
build: release Lotus Node v1.31.1-rc1
- 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)
- 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 GitHub UI search looking at merged PRs into master: https://github.com/filecoin-project/lotus/pulls?q=is%3Apr+base%3Amaster+merged%3A%3EYYYY-MM-DD
- Example
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
- Example command looking at git commits:
- 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: Lotus Node v1.31.1 ReleaseΒ #12827 (comment)
Testing for rc1
[!NOTE]
Link to any special steps for testing releases beyond ensuring CI is green. Steps can be inlined here or tracked elsewhere.
Stable Release (non-RC)
Section
[!IMPORTANT]
These PRs should be done in and target therelease/v1.31.1
orrelease/miner/v1.31.1
branch.
Backport PR for Stable Release (non-RC)
- All explicitly tracked items from
Dependencies for releases
have landed - Backported everything with the "backport" label
- Removed the "backport" label from all backported PRs (no "backport" issues)
- Create a PR with title
build: backport changes for Node v1.31.1
- Link to PR:
- Merge PR
Release PR for Stable Release (non-RC)
- Update the version string(s) in
build/version.go
to one *NOT ending with 'rcX'.- Ensure to update
NodeBuildVersion
- Ensure to update
- Run
make gen && make docsgen-cli
to generate documentation - Create a draft PR with title
build: release Lotus Node v1.31.1
- Link to PR: build: release Lotus Node v1.31.1Β #12850
- 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)
- 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 GitHub UI search looking at merged PRs into master: https://github.com/filecoin-project/lotus/pulls?q=is%3Apr+base%3Amaster+merged%3A%3EYYYY-MM-DD
- Example
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
- Example command looking at git commits:
- 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: Lotus Node v1.31.1 ReleaseΒ #12827 (comment)
Testing for Stable Release (non-RC)
[!NOTE]
Link to any special steps for testing releases beyond ensuring CI is green. Steps can be inlined here or tracked elsewhere.
β‘ Post-Release
Section
- Open a PR against
master
cherry-picking the CHANGELOG commits from therelease/v1.31.1
branch. Title itchore(release): cherry-pick v1.31.1 changelog back to master
- Link to PR: chore(release): cherry-pick v1.31.1 changelog back to masterΒ #12851
- Assuming we followed the process of merging changes into
master
first before backporting to the release branch, the only changes should be CHANGELOG updates.
- Finish updating/merging the RELEASE_ISSUE_TEMPLATE.md PR from
Before RC1
with any improvements determined from this latest release iteration.
β€οΈ Contributors
See the final release notes!
βοΈ Do you have questions?
Leave a comment in this ticket!