Document the 0.3.0 lockfile migration (#219) - #258
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Explain the expanded `lading bump` lockfile discovery and direct users to the existing configuration and publishing recovery guidance.
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueWarning Your free Security trial is over. An organization admin can upgrade to Advanced for continuous pull request security review or dismiss this notice. Comment |
Reviewer's GuideThis 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 migrationflowchart 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]
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: passedmake check-fmt: passedmake markdownlint: passedmake nixie: passedReferences
Summary by Sourcery
Document the lading 0.3.0 lockfile regeneration migration and guide users through reviewing, previewing, and recovering lockfile updates.
Enhancements:
Documentation: