Repository navigation
Publish the crate under the name ragfer - #300
Merged
Merged
Conversation
- package name: rag-ferrite -> ragfer (the crate now matches the binary, the repository name and ~/.config/ragfer; nothing was ever published, so no user is affected). - homepage, keywords and categories were declared inside the [[bin]] table, where cargo silently ignores them: moved into [package] so crates.io actually gets them. - exclude docs/, graphify-out/, AGENTS.md and llms.txt from the published crate: it ships what builds and runs it, the documentation stays in the repo. - rename docs/adr/0010-...vec<char>...md to docs/adr/0010-...vec-char...md: cargo refuses to package a filename containing '<' or '>', and no exclude pattern avoids that check. Index link in docs/DECISIONS.md updated.
Add the crates.io badge and a "From crates.io" install section, and state the naming explicitly: the project is rag-ferrite (repository, docs, website) while ragfer is what you install and type.
cargo audit fails the release gate on rustls 0.23.40 (TLS 1.3 handshake messages accepted across encryption level boundaries, fixed in 0.23.45). The advisory was published after the last green run on main, so this is not caused by the crate publication changes.
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.
The changes that were needed to put this crate on crates.io, applied for the
5.3.0publication. The crate is already live as https://crates.io/crates/ragfer; this PR bringsmainin line with what was shipped.What it does:
rag-ferrite→ragfer, so the crate matches the binary, the command and the repository's technical name. Nothing had ever been published, so no user is affected.homepage,keywords,categoriesmoved into[package]. They were declared inside the[[bin]]table, where cargo ignores them silently — the crate would have published with no keywords and no category. The published crate page confirms the fix. (The rest of that misplacement is tracked in Clean Cargo metadata, dependencies, and advisory exceptions #276.)exclude = ["docs", "graphify-out", "AGENTS.md", "llms.txt"]. The crate ships what builds and runs the tool; the project documentation stays in the repository.docs/adr/0010-chunker-uses-vec<char>-indexing-not-char_indices.mdrenamed to…uses-vec-char…. Cargo refuses to package any filename containing<or>, and noexcludepattern avoids that check — four were tried (docs/adr,docs/adr/**,docs/adr/*,**/0010-*, all still refused). The index link indocs/DECISIONS.mdis updated.cargo install ragfer, and the naming stated once — the project is ragFerrite,ragferis what you install and type.Closes #297.