Repository navigation
chore: the metadata crates.io needs, and a README for each crate - #1
Merged
Merged
Conversation
None of the four publishable crates had `keywords`, `categories` or a `readme`. The effect is not cosmetic: without categories a crate does not appear when anyone browses crates.io by subject, and without a readme its page is the description and nothing else. `aerospace::space-protocols` is the category for all four — it is also the key the AeroRust catalogue collects entries by — with a second one each for what the crate is: a parser, an encoder, a development tool, a command-line utility. The READMEs are short and say the thing that is true of that crate rather than repeating the workspace: that `xtce-decode` is tested packet for packet against the Python reference on nine streams, that `xtce-codegen` refuses rather than falls back, that `xtce model` keeps everything it cannot decode so a real mission database still loads. `cargo publish -p xtce-model --dry-run` packages 19 files cleanly. The other three cannot be dry-run until their dependencies exist on crates.io, which is the order they would be published in anyway.
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.
Preparation for publishing, not the publishing itself.
None of the four publishable crates carried
keywords,categoriesor areadme. That isnot cosmetic: without a category the crate never appears when somebody browses crates.io by
subject, and without a readme its page is one line of description.
xtce-modelaerospace::space-protocols,parser-implementationsxtce-decodeaerospace::space-protocols,encodingxtce-codegenaerospace::space-protocols,development-toolsxtce-cliaerospace::space-protocols,command-line-utilitiesaerospace::space-protocolsis also the key the AeroRust catalogue collects entries by.Each crate gets a short README saying the thing that is true of it rather than repeating the
workspace — that
xtce-decodeis tested packet for packet against the Python reference on ninestreams, that
xtce-codegenrefuses rather than silently falling back to interpretation, thatxtce-modelrepresents what it cannot decode so a real mission database still loads.cargo publish -p xtce-model --dry-runpackages 19 files, 271.8 KiB, clean. The other threecannot be dry-run until their dependencies are on crates.io — which is the order they would be
published in anyway, and worth knowing before the evening that does it.
179 tests, fmt clean.