Summary
Add a 0.3.0 migration document or a 0.3.0 migration section for the lockfile regeneration changes delivered by PR #160.
Rationale
The user guide documents the behaviour in detail. Users upgrading to the next release need a migration entry that signposts the changed lockfile behaviour and the available recovery path.
Affected areas
- Add the migration document or section in the repository's release or migration documentation.
- Link to the existing user-guide material when that avoids duplicated operational detail.
Required content
Document all of the following:
lading bump discovers Git-tracked Cargo.lock files and includes their adjacent Cargo.toml manifests.- Dry-run discovers and reports the same lockfile set without modifying files.
- In a non-Git workspace, discovery falls back to
bump.lockfile_manifests and emits a warning.
bump.lockfile_manifests extends coverage for untracked lockfiles and nested lockfiles in non-Git workspaces.lading bump --no-rebuild-lockfiles is the regeneration escape hatch. Explain that users must regenerate stale lockfiles before publishing when they use it or modify manifests directly.
Acceptance criteria
- Add a 0.3.0 migration document or migration section.
- Explain tracked-lockfile discovery, dry-run output, configuration fallback, and the regeneration escape hatch.
- Keep the content consistent with
docs/users-guide.md.
- Add navigation or an index link when the documentation structure requires one.
- Validate documentation formatting and links with the repository's documented validation targets.
Backlinks
Summary
Add a 0.3.0 migration document or a 0.3.0 migration section for the lockfile regeneration changes delivered by PR #160.
Rationale
The user guide documents the behaviour in detail. Users upgrading to the next release need a migration entry that signposts the changed lockfile behaviour and the available recovery path.
Affected areas
Required content
Document all of the following:
lading bumpdiscovers Git-trackedCargo.lockfiles and includes their adjacentCargo.tomlmanifests.bump.lockfile_manifestsand emits a warning.bump.lockfile_manifestsextends coverage for untracked lockfiles and nested lockfiles in non-Git workspaces.lading bump --no-rebuild-lockfilesis the regeneration escape hatch. Explain that users must regenerate stale lockfiles before publishing when they use it or modify manifests directly.Acceptance criteria
docs/users-guide.md.Backlinks