Skip to content

feat: update forest-cli snapshot export to use v2 format by default #6145

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

Jump to bottom
Merged
elmattic merged 3 commits into from
Oct 10, 2025
Merged

feat: update forest-cli snapshot export to use v2 format by default #6145

elmattic merged 3 commits into from
Oct 10, 2025

Conversation

@hanabi1224
Copy link
Contributor

@hanabi1224 hanabi1224 commented Oct 9, 2025 •
edited by coderabbitai bot
Loading

Summary of changes

@ADobrodey please help confirm this change does not break any infra services and scripts. It'd be great to specify --format everywhere

Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • New Features

    • Snapshot export now defaults to the V2 format, affecting exports that don't explicitly set a format.
    • Export progress output is clearer, showing the version (e.g., v2) and the destination path during runtime.

  • Chores

    • Updated default snapshot export configuration to the latest format.
    • Improved runtime message formatting for export operations.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 9, 2025 •
edited
Loading

Walkthrough

Default snapshot export format switched from V1 to V2 in the CLI snapshot export command. The user-facing progress message was updated to include an explicit "v{version}" prefix and the destination path. No control-flow, type, or API signature changes.

Changes

Cohort / File(s) Summary
Snapshot export CLI options
src/cli/subcommands/snapshot_cmd.rs		 Changed default format from FilecoinSnapshotVersion::V1 to FilecoinSnapshotVersion::V2; updated progress message to include v{version} and the destination path.
Changelog
CHANGELOG.md		 Added note under "Forest unreleased > Changed" documenting that forest-cli snapshot export now defaults to v2 format (PR #6145).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • elmattic
  • sudo-shashank

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly describes the primary change of updating the default snapshot export format of forest-cli to v2, clearly reflecting the main purpose of the pull request and following a concise, conventional commit style without irrelevant details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch hm/snapshot-export-v2-by-default
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f61c5d1 and f1c3515.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: Build Ubuntu
  • GitHub Check: Build MacOS
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: All lint checks
  • GitHub Check: tests-release
  • GitHub Check: tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@hanabi1224 hanabi1224 marked this pull request as ready for review October 9, 2025 12:55
@hanabi1224 hanabi1224 requested a review from a team as a code owner October 9, 2025 12:55
@hanabi1224 hanabi1224 requested review from ADobrodey, elmattic and sudo-shashank and removed request for a team October 9, 2025 12:55
coderabbitai[bot]
coderabbitai bot reviewed Oct 9, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/cli/subcommands/snapshot_cmd.rs (1)

42-42: Approve V2 as default snapshot format

  • Confirmed V2 is production-ready and now the recommended default (NV27/F3, Lotus defaults).
  • Only scripts/tests/snapshot_parity/docker-compose.yml relies on default; both forest-cli and lotus now default to v2, so parity tests pass unchanged.
  • No other hardcoded V1 defaults detected.
  • Optional: update documentation or tests to explicitly reference v2 default.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b07bd5b and f61c5d1.

📒 Files selected for processing (1)
  • src/cli/subcommands/snapshot_cmd.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: tests-release
  • GitHub Check: tests
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: All lint checks
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: Build Ubuntu
  • GitHub Check: Build MacOS
🔇 Additional comments (1)
src/cli/subcommands/snapshot_cmd.rs (1)

137-137: FilecoinSnapshotVersion can be safely cast to u64.

It’s already serialized with *self as u64 and deserialized via from_u64, so including format as u64 in the progress message is correct.

@elmattic elmattic added this pull request to the merge queue Oct 10, 2025
Merged via the queue into main with commit d7e6627 Oct 10, 2025
50 checks passed
@elmattic elmattic deleted the hm/snapshot-export-v2-by-default branch October 10, 2025 16:55
@coderabbitai coderabbitai bot mentioned this pull request Oct 13, 2025
Merged
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request Oct 30, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@sudo-shashank sudo-shashank sudo-shashank approved these changes

@ADobrodey ADobrodey Awaiting requested review from ADobrodey

+1 more reviewer

@elmattic elmattic elmattic approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@hanabi1224 @elmattic @sudo-shashank