docs: prepare rustfs-uring 0.1.0 for release (docs + metadata)#10
Merged
Conversation
Supersedes the earlier "restore README" intent. The maintainer decision is to make 0.1.0 publish-ready but hold the actual crates.io release, so: - README: keep the crates.io/docs.rs badges (they go live on release), on top of #8's corrected formatting (de-indented O_DIRECT doctest, compact table) that #9's stale base had reverted. The Status note now says 0.1.0 is publish-ready with `publish = false` held until a maintainer cuts the release, rather than "not published". - Cargo.toml: keep `publish = false` but document that it is a hold, not a blocker — metadata is complete and every dependency is on crates.io, so the flip-and-`cargo publish` is a one-step maintainer action. - CHANGELOG: reframe the note the same way and record that the `[Unreleased]` section will move under `[0.1.0]` unchanged on release. No code change; no `cargo publish` performed (that stays a maintainer action with their token). README/CHANGELOG/Cargo.toml only. Co-Authored-By: heihutu <heihutu@gmail.com>
houseme
force-pushed
the
docs/fix-readme-regression
branch
from
4c7ffd5 to
9f8f6c1
Compare
houseme
changed the title
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.
Context
Follow-up to the badge question on #9. Two things converged here:
publish = falseis kept as a deliberate hold, not because anything blocks it.Change (docs + metadata only)
publish = falseheld until a maintainer cuts the release".publish = falsekept, comment updated to say it is a hold and how to flip it.[Unreleased]section moves under[0.1.0]unchanged on release.No code change. No
cargo publish— that remains a maintainer action with their crates.io token. When ready: flippublish = false,cargo publish, then optionally switch rustfs/rustfs's ecstore dependency from the git rev to the crates.io version.