Repository navigation
docs: add an upgrade guide for breaking changes - #377
Merged
Merged
Conversation
Add docs/upgrading.md listing, per release, only what callers must change with before/after code, assembled from the **Breaking:** changelog entries. Covers v0.10.0 (twelve breaking changes; two require a source change, the rest fail closed on specific call patterns) and backfills v0.9.0. CHANGELOG stays the full record. Adds the docs index row. Closes #314
ffumero2003
requested review from
goanpeca and
sophiecarreras
as code owners
November 10, 2026 21:46
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.
Context
A pre-1.0 minor release can break callers, but the only record is the full
CHANGELOG. Users whose build or a call breaks have to read the whole list to find why. Closes #314.Changes
docs/upgrading.md: one section per breaking release listing only what callers must change, with before/after code, assembled from the**Breaking:**changelog entries.CHANGELOG.mdstays the full record.WriterOption→WriterOptionFunc; the variadickeys ...*SSECKeyonNewReader/NewRangeReader/Attrs) and the rest, which fail closed on specific call patterns (CopyToBucket(nil), emptyBucketIDs, invalid lifetimes, ranged-response validation, replication on create/update,syncdefault compare + platform support,NewRangeReaderlength 0, multipleFileLock,Writer.Closewaiting).base.CreateBucketnew args, upload retry log text).docs/README.mdindex row.Backfill range: v0.9.0 and v0.10.0 (the releases with
**Breaking:**entries).Verification
git diff --check: clean.main) in a temporary in-module package —go build ./...succeeds:WriterOptionFunc, theNewReaderclosure,CopywithCopyToBucket,CreateKeywithBucketIDsand withLifetime,NewBucketwithattrs.ReplicationConfig = nil,SyncwithWithCompare(CompareSHA1), andNewRangeReader(ctx, offset, -1). The temporary file was removed; the PR contains only the two docs.**Breaking:**line in.changes/v0.10.0.md.Docs-only; no library behavior change (uses
skip-changelog).Closes #314