Repository navigation
Make the README read as of a release - #13
Merged
Merged
Conversation
The README still described a project that only had prereleases: its badge counted them, and Install led with --devel. Now: - The badge shows the latest stable release. - Install leads with installing the latest release, says to pin a version from the releases page, and shows how to verify the image signature rather than only pointing at the release notes. - "Project status" becomes "Releases and compatibility": where releases and their notes are, what v1 promises, that Weft itself is pre-1.0, what prereleases are for, and a pointer for upgrading from weft.run. No version number is written into the README. Versions are derived and never bumped by hand, so a literal one would be stale after the next release; the badge carries it instead.
It read as a disclaimer on the release it ships with. Keep only the commitment that matters: changes are called out in release notes.
The README describes Weft; release notes describe releases.
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
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.
What this changes
The README still described a project with only prereleases: the release badge counted them, and Install led with
--devel. After this:--versionfrom the releases page. It also shows thecosign verifycommand inline, instead of only pointing at the release notes.v1promises (a breaking change would be a new API version). It also says that Weft itself is pre-1.0, what prereleases are for, and points to the migration guide forweft.runinstalls.No version number is written into the README. Versions are derived by GitVersion and never bumped by hand, so a literal
0.1.0would be stale after the next release; the badge carries the current version instead. Until the first release is cut, the badge shows "no releases or repo not found".Checks
make generateproduces no diff (docs only)make testpasses (docs only; no code touched)make lintis clean (docs only)