docs(dar-archive): add missing crate README (unbreak release-plz publish) - #2
Closed
h4x0r wants to merge 1 commit into
Closed
docs(dar-archive): add missing crate README (unbreak release-plz publish)#2h4x0r wants to merge 1 commit into
h4x0r wants to merge 1 commit into
Conversation
release-plz's release job failed to publish dar-archive: `readme README.md does not appear to exist (relative to crates/dar-archive)`. crates/dar-archive/Cargo.toml declares `readme = "README.md"` but the file was absent, so `cargo publish` aborted. Add a real README (tagline, features, usage) describing the DAR archive reader, written from its public API (DarArchive::open/open_slices, entries(), read()). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
Closing: chat4n6 is not a fleet member (confirmed 2026-07-27), so fleet release-plz standards don't apply here. The dar-archive README fix on the branch remains available if you want it, but it's out of scope for the fleet audit that opened this PR. |
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
1 participant
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.
Problem
release-plz's release job failed:
failed to publish dar-archive→readme README.md does not appear to exist (relative to crates/dar-archive).Root cause & fix
crates/dar-archive/Cargo.tomldeclaresreadme = "README.md", butcrates/dar-archive/README.mddid not exist, socargo publishaborted beforeuploading. Rather than drop the
readme =key (the crate publishes and shouldhave one), this adds a real README — tagline, features, and a usage example —
written from the crate's actual public API (
DarArchive::open/open_slices,entries(),read()) andlib.rs, matching the style of the sibling crateREADMEs in this workspace.
Verification (local)
cargo package -p dar-archive --no-verifyno longer errors on the readme (theonly remaining message was the expected "uncommitted new file").
--allow-dirty --list,README.mdis included in the package (12 files).🤖 Generated with Claude Code