Repository navigation
docs: prepare the README and notes for the v0.2.0 final - #671
Merged
Merged
Conversation
The README told readers that main was a release candidate and pinned its install examples to v0.2.0-rc.1, and the notes had a section on installing a candidate that only makes sense before the final ships. The README now pins v0.2.0 in its example and points v0.1.3 users at flynn upgrade and the upgrade notes. The rc-only paragraphs are gone. The general instructions for testing a future candidate stay. The notes keep the one fact from the candidate section that still applies (v0.1.3 cannot read a data directory v0.2.0 wrote) under Upgrading, and add two known limitations: a planner that writes a check for a file outside the working directory, which the sandbox then refuses, and the GO-2026-5932 report from scanners that match by module version, with why Flynn does not reach the affected packages. Signed-off-by: Ion Alpha <contact@ionalpha.io>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Rewrites the README's install section and the v0.2.0 notes for the final release: the install example pins
v0.2.0, the paragraphs that calledmaina release candidate and pointed atv0.2.0-rc.1are gone, and the notes gain two known limitations.Why
v0.2.0-rc.2 is soaking and the final will be tagged from
main. The release workflow publishesdocs/releases/v0.2.0.mdas the release body, so the notes and README must read correctly for the final before the tag is pushed.How to verify
git grep -n "0.2.0-rc"lists only intentional examples (the release workflow comment,dev/upgrade-checkusage,docs/releases/README.md, and thedeploy/README.mdnote for units installed from rc.1).Notes for reviewers
golang.org/x/crypto, which Flynn does not import.docs/UPGRADE.mdanddocs/VERSIONING.mdneeded no change: UPGRADE's sample is recorded output from a real v0.1.3 upgrade, and VERSIONING names no release.