Skip to content

Document the 0.3.0 lockfile migration (#219) - #258

Draft
leynos wants to merge 1 commit into
mainfrom
issue-219-document-0-3-0-migration-for-lockfile-discovery-and-regeneration
Draft

Document the 0.3.0 lockfile migration (#219)#258
leynos wants to merge 1 commit into
mainfrom
issue-219-document-0-3-0-migration-for-lockfile-discovery-and-regeneration

Conversation

@leynos

@leynos leynos commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Summary

This branch documents the 0.3.0 lockfile-regeneration migration introduced by
PR #160. It signposts Git-tracked lockfile discovery, dry-run reporting, the
non-Git configuration fallback, and the pre-publish recovery path.

Closes #219.

Review walkthrough

Validation

  • make fmt: passed
  • make check-fmt: passed
  • make markdownlint: passed
  • make nixie: passed

References

Summary by Sourcery

Document the lading 0.3.0 lockfile regeneration migration and guide users through reviewing, previewing, and recovering lockfile updates.

Enhancements:

  • Add a 0.3.0 migration guide covering lockfile discovery, configuration fallback, dry-run inspection, and pre-publish recovery.
  • Update documentation navigation and repository-layout guidance to include release-specific migration guides.

Documentation:

  • Document the lockfile regeneration migration for lading 0.3.0 and link it from the documentation index.

Explain the expanded `lading bump` lockfile discovery and direct users to
the existing configuration and publishing recovery guidance.
@coderabbitai

coderabbitai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Warning

Your free Security trial is over. An organization admin can upgrade to Advanced for continuous pull request security review or dismiss this notice.


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

@sourcery-ai

sourcery-ai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Reviewer's Guide

This documentation-only PR adds and indexes a 0.3.0 migration guide for the lockfile-regeneration changes introduced by PR #160, covering Git-based discovery, configuration fallback, dry-run verification, and publish-time recovery, while establishing the repository location for future migration guides.

Flow diagram for the 0.3.0 lockfile migration

flowchart TD
    A[Run lading bump] --> B{Git workspace?}
    B -->|Yes| C[Discover Git-tracked Cargo.lock files outside target]
    B -->|No| D[Warn and use bump.lockfile_manifests]
    C --> E[Include adjacent Cargo.toml manifests]
    D --> E
    E --> F{Dry run?}
    F -->|Yes| G[Report lockfiles with lockfile suffix]
    F -->|No| H[Regenerate affected lockfiles]
    H --> I[lading publish]
    I --> J{Stale lockfiles?}
    J -->|Yes| K[Run reported repair commands]
    J -->|No| L[Publish]
Loading

File-Level Changes

Change Details Files
Add a 0.3.0 migration guide explaining automatic lockfile discovery, configuration fallback, dry-run behavior, and pre-publish recovery.
  • Document discovery of Git-tracked nested Cargo.lock files and adjacent manifests.
  • Explain the configuration fallback for untracked lockfiles and non-Git workspaces.
  • Describe dry-run reporting and the procedure for repairing stale lockfiles before publishing.
docs/migrations/0.3.0-lockfile-regeneration.md
Expose the migration guide through the documentation structure and define its ownership conventions.
  • Add the migration guide to the documentation index.
  • Specify docs/migrations/ for release-specific upgrade guidance.
docs/contents.md
docs/repository-layout.md

Assessment against linked issues

Issue Objective Addressed Explanation
#219 Add a 0.3.0 migration document or section covering the changed lockfile discovery, dry-run behavior, configuration fallback, and regeneration escape hatch.
#219 Document that Git-tracked Cargo.lock files and adjacent Cargo.toml manifests are discovered, that dry-run reports the same set without changes, and that non-Git workspaces fall back to bump.lockfile_manifests with a warning; explain how the setting covers untracked and nested lockfiles.
#219 Document the --no-rebuild-lockfiles recovery path and provide appropriate migration-guide navigation while keeping details linked to the users guide.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

codescene-access[bot]

This comment was marked as outdated.

@codescene-access codescene-access Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No quality gates enabled for this code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document 0.3.0 migration for lockfile discovery and regeneration

1 participant