You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With the writer compliance suite, parity gate, byte-budget contract, and tier split in place, the gating evidence to flip the local COG paths to stable exists. This issue captures that flip and the documentation that goes with it.
Required changes
xrspatial/geotiff/_attrs.py
writer.cog: advanced → stable
reader.local_cog: advanced → stable
reader.http_cog: stays advanced (HTTP COG has separate transport/security/coalescing concerns; the byte-budget contract in Pin HTTP/range COG byte-budget contract (#2293) #2298 pins behavior but does not yet make a promotion case)
Update the comment block above SUPPORTED_FEATURES to describe what the stable COG contract guarantees and what stays advanced.
docs/source/reference/geotiff.rst
Add a section titled something like "Stable COG contract" with these bullets verbatim (or close), pulled from #2286:
Update any prose that says "use with caution" / "experimental" for COG writer paths to reflect the stable contract. Keep the cautious phrasing for HTTP COG and the out-of-scope combos.
Release notes
Add an entry in the release notes file describing the COG stability contract — what is now stable, what stays advanced, and the gating tests that back the promotion (#2292, #2293, #2294 compliance + parity + byte-budget).
Out of scope
BigTIFF COG (tracked separately).
HTTP COG promotion (tracked separately).
Error-message UX (tracked separately).
Touching _writer.py or any other production code path.
Acceptance
SUPPORTED_FEATURES['writer.cog'] == 'stable' and SUPPORTED_FEATURES['reader.local_cog'] == 'stable'.
reader.http_cog remains advanced with a documented reason in the code comment.
Docs reference page renders with the stable-contract section and the out-of-scope list.
Follow-up to #2286 wave 1 (#2291, #2292, #2293, #2294 — all merged).
With the writer compliance suite, parity gate, byte-budget contract, and tier split in place, the gating evidence to flip the local COG paths to
stableexists. This issue captures that flip and the documentation that goes with it.Required changes
xrspatial/geotiff/_attrs.pywriter.cog:advanced→stablereader.local_cog:advanced→stablereader.http_cog: staysadvanced(HTTP COG has separate transport/security/coalescing concerns; the byte-budget contract in Pin HTTP/range COG byte-budget contract (#2293) #2298 pins behavior but does not yet make a promotion case)SUPPORTED_FEATURESto describe what the stable COG contract guarantees and what stays advanced.docs/source/reference/geotiff.rstAdd a section titled something like "Stable COG contract" with these bullets verbatim (or close), pulled from #2286:
none,deflate,lzw,zstd,packbits.And a "Outside the stable contract" section listing:
lerc,jpeg2000,j2k,lz4)..tif.ovrsidecars.cog=True.examples/user_guide/52_COG_Overview_Generation.ipynbUpdate any prose that says "use with caution" / "experimental" for COG writer paths to reflect the stable contract. Keep the cautious phrasing for HTTP COG and the out-of-scope combos.
Release notes
Add an entry in the release notes file describing the COG stability contract — what is now stable, what stays advanced, and the gating tests that back the promotion (#2292, #2293, #2294 compliance + parity + byte-budget).
Out of scope
_writer.pyor any other production code path.Acceptance
SUPPORTED_FEATURES['writer.cog'] == 'stable'andSUPPORTED_FEATURES['reader.local_cog'] == 'stable'.reader.http_cogremainsadvancedwith a documented reason in the code comment.