Lotus Node & Miner Release v1.30.0 (nv24)

[BigLep]

😶‍🌫 Meta

• Scope: Node & Miner
• Is this linked with a network upgrade, and thus mandatory?
• (network upgrade) Related network upgrade version: nv24
  • (network upgrade) Scope, dates, and epochs: Network Updates (Currently: v23 Waffle 🧇 ) community#74 (comment)
  • (network upgrade) Lotus changelog with Lotus specifics: <link to section in https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md with more details>

🚢 Estimated shipping date

Candidate	Date	Release URL
RC1	Week of 2024-10-08	https://github.com/filecoin-project/lotus/releases/tag/v1.30.0-rc1 https://github.com/filecoin-project/lotus/releases/tag/miner%2Fv1.30.0-rc1
RC2	Week of 2024-10-14	https://github.com/filecoin-project/lotus/releases/tag/v1.30.0-rc2 https://github.com/filecoin-project/lotus/releases/tag/miner%2Fv1.30.0-rc2
Stable (non-RC)	Week of 2024-10-28 (estimate)

🪢 Dependencies for releases

Note

1. 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.
2. They can be checked as done once they land in master.
3. They are presented here for quick reference, but backporting is tracked in each Release Checklist.

rc1

• feat: implement ticket based F3 participation lease #12531
• feat(f3): prepare for f3 bootstrap #12552
• chore: update filecoin-ffi to v1.30.0-rc2 #12561

rc2

• test: validate MCOPY opcode for FIP-0094 #12556
• fix(events): event index unique for tipset during backfill #12567
•  fix: update actor code ID in lotus-shed invariant check #12572
•  chore: set Calibration upgrade epoch for nv24 #12573
•  fix: set address current network for non-mainnet since default is changed #12574
•  fix(f3): fix hot loop in F3 participation #12575
• fix(f3): improve log messages #12576
• fix(f3): send the last gpbft message for each new participant #12577
• fix(f3): log the correct number of instances remaining #12578
• fix(f3): handle a case where we might receive no manifest #12579
• feat(f3): remove lease-check interval constants #12580
• feat(f3): log when gaining/losing participation leases #12581
•  feat: improve semantics for returning reverted events to event API users #12585
•  fix: bug in exclude reverted logic for eth_getLogs #12588
•  feat(f3): refactor the F3 participation module for easier testing #12589
• fix: fix address network override via env var #12590
• fix(f3): don't return an error on stop if our context was canceled #12592
• fix(miner): fix new bug in StateMinerPreCommitDepositForPower calculation #12595

rc3

•  fix: determine F3 participants relative to current network name #12597
•  chore: update triplewz/poseidon #12602
•  feat: implement F3 list participants API #12608
•  fix: support Forrest parity testing for F3 participation APIs #12615
•  fix: handle negative value for LOTUS_DISABLE_F3 env var gracefully #12620
•  chore: remove redundant F3Consensus build parameter #12621

Stable (non-RC)

• To Be Added

✅ Release Checklist

Before RC1

• (network upgrade) Make sure all Lotus dependencies are updated to the correct versions for the network upgrade
  • Link to Lotus PR: feat(fip0081): initialPledge calculation & ramp, plus migration tests #12526, chore: update filecoin-ffi to v1.30.0-rc2 #12561
• Open PR against RELEASE_ISSUE_TEMPLATE.md with title docs(release): v1.30.0 release template improvements for improving future releases.
  • Link to PR: docs(release): v1.30.0 and v1.31.0 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.
• (minor release) Fork a new branch (release/v1.30.0 or release/miner/v1.30.0) from master 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.30.1-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.30.0
    • Set the UNRELEASED v1.30.0 section's content to be "See https://github.com/filecoin-project/lotus/blob/release/v1.30.0/CHANGELOG.md"
    • Add a new UNRELEASED header to top.
  • Create a PR with title build: update Lotus Node|Miner version to v1.30.1-dev in master
    • Link to PR: build: update Node and Miner version to v1.30.1-dev in master #12562
  • Merge PR

RCs

rc1

Important

These PRs should be done in and target the release/v1.30.0 or release/miner/v1.30.0 branch.

Release PR

• Update the version string(s) in build/version.go to one ending with '-rc1'.
  • 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|miner v1.30.0-rc1
  • Link to PR: build: release Lotus node and miner v1.30.0-rc1 #12564
  • 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 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 (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: Lotus Node & Miner Release v1.30.0 (nv24) #12480 (comment)

rc2

Important

These PRs should be done in and target the release/v1.30.0 or release/miner/v1.30.0 branch.

Backport PR

• 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|miner v1.30.0-rcX
  • Link to PR: build: backport changes for v1.30.0-rc2 #12598
• Merge PR

Release PR

• Update the version string(s) in build/version.go to one ending with '-rc2'.
  • 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|miner v1.30.0-rc2
  • Link to PR: build: release Lotus node and miner v1.30.0-rc2 #12599
  • 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 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 (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

2️⃣ make these changes:

1. Release PR > Update the version string...
   • Update the version string in build/version.go to one NOT ending with '-rcX'
2. Release PR > Changelog prep...
   • Add "(network upgrade) Ensure the Mainnet upgrade epoch is specified."
3. Release PR > Create a draft PR...
   • Create a PR with title build: release Lotus node|miner v1.30.0

3️⃣ Remove this [!Note] and the related invisible comments.

Important

These PRs should be done in and target the release/v1.30.0 or release/miner/v1.30.0 branch.

Backport PR

• 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|miner v1.30.0-rcX
  • Link to PR:
• Merge PR

Release PR

• Update the version string(s) in build/version.go to one NOT 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|miner v1.30.0
  • 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) Ensure the Mainnet upgrade epoch is specified.
  • 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 (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 release
  • Link to issue comment:

Post-Release

• Open a PR against master cherry-picking the CHANGELOG commits from the release/v1.30.0 branch. Title it chore(release): cherry-pick v1.30.0 changelog back to master
  • Link to PR:
  • 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!

[rjan90]

2024-10-08

The first release candidates, v1.30.0-rc1 was shipped:

• https://github.com/filecoin-project/lotus/releases/tag/v1.30.0-rc1
• https://github.com/filecoin-project/lotus/releases/tag/miner%2Fv1.30.0-rc1

[rjan90]

The second release candidates, v1.30.0-rc2 has been shipped with upgrade epochs for the Calibration network set:

• https://github.com/filecoin-project/lotus/releases/tag/v1.30.0-rc2
• https://github.com/filecoin-project/lotus/releases/tag/miner%2Fv1.30.0-rc2