Repository navigation
Fix publish workflow ordering and per-crate readme paths - #187
Merged
huntsman90 merged 1 commit intoJun 25, 2026
Merged
Conversation
Two related fixes for the crates.io publish pipeline:
1. Set `readme = "README.md"` directly in `pb-jelly/Cargo.toml` and
`pb-jelly-gen/Cargo.toml` instead of inheriting `readme.workspace =
true`. The workspace-level `readme = "README.md"` resolves relative to
the workspace root, so packaging emitted a warning like
`readme '../README.md' appears to be a path outside of the package`
and would have caused crates.io to render the workspace umbrella
README on each crate's page instead of the per-crate README.
2. Reorder steps in `.github/workflows/publish.yml` so that
`pb-jelly-gen`'s dry-run happens *after* the real publish of
`pb-jelly` (and the index-wait sleep). When both crates are bumped to
the same version in lockstep, dry-running `pb-jelly-gen` first fails
to resolve `pb-jelly = "^X.Y.Z"` against crates.io because that
version doesn't exist yet. New ordering:
1. Dry run pb-jelly
2. Authenticate
3. Publish pb-jelly
4. Wait for crates.io index
5. Dry run pb-jelly-gen (now pb-jelly X.Y.Z is on crates.io)
6. Publish pb-jelly-gen
Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Two related fixes for the crates.io publish pipeline:
Set
readme = "README.md"directly inpb-jelly/Cargo.tomlandpb-jelly-gen/Cargo.tomlinstead of inheritingreadme.workspace = true. The workspace-levelreadme = "README.md"resolves relative to the workspace root, so packaging emitted a warning likereadme '../README.md' appears to be a path outside of the packageand would have caused crates.io to render the workspace umbrella README on each crate's page instead of the per-crate README.Reorder steps in
.github/workflows/publish.ymlso thatpb-jelly-gen's dry-run happens after the real publish ofpb-jelly(and the index-wait sleep). When both crates are bumped to the same version in lockstep, dry-runningpb-jelly-genfirst fails to resolvepb-jelly = "^X.Y.Z"against crates.io because that version doesn't exist yet. New ordering: