docs: prepare the v0.3.0 release - #44
Open
patramsey wants to merge 1 commit into
Open
Conversation
Fifteen user-facing changes since v0.2.4, from #39 and #41. Minor rather than patch because of the exit codes. Invocation mistakes — a bad flag value, an unknown record type, a missing required flag — used to exit 1, indistinguishable from an API or runtime failure, and now exit 2 as the documented table has always claimed. That is a fix, but it is one a script can be depending on, so it gets a note at the top of the section rather than a line buried under Fixed. The release also adds --wide, which is a feature and a minor bump on its own. The rest is what the audit turned up: a mistyped subcommand that exited 0, tables that overflowed an 80-column terminal, credentials that existed being reported as missing, seven list commands that could page forever, a 429 with a long Retry-After that decayed into a timeout, error bodies echoed at 20 KB, and one idempotency key shared across every write in an invocation. Only CHANGELOG.md changes; the build version comes from the tag.
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.
Fifteen user-facing changes since v0.2.4, from #39 and #41. Only
CHANGELOG.mdchanges — the build version comes from the tag.
Why 0.3.0 and not 0.2.5
Invocation mistakes now exit 2 instead of 1. A bad flag value, an unknown
record type, a missing required flag — all previously exited 1, the same code as
an API or runtime failure, and now exit 2 as the documented table has always
said.
It is a fix, but it is one a script can be depending on:
namecom dns create example.com --type ZZZ --answer 1.2.3.4 # v0.2.4: exit 1 v0.3.0: exit 2So it gets a note at the top of the section rather than a line buried under
### Fixed.--wideis also a new flag, which is a minor bump on its own.Nothing else changes an exit code, and no command changes what it sends to the
API.
What's in it
--wide— keep every table column even when it overflows--timeoutdescribed as the total budget for a call including retriesCLAUDE.mdcorrected on POST retry behaviourThe fixes, briefly: a mistyped subcommand exited 0 (so
namecom domain regsiter foo.com && deploydeployed); tables overflowed an 80-column terminal and theborders shattered; credentials that existed were reported as missing while
config list-profilesprinted them; seven list commands could page foreveragainst a server whose
nextPagenever advanced; a 429 with a longRetry-Afterwas slept on until the deadline expired and reported as atransport error; non-JSON error bodies were echoed verbatim at 20 KB; and one
idempotency key was shared across every write in an invocation.
Verification
make test,make lint, andmake buildpass. The bullet set under the new## [0.3.0]heading is byte-identical to what was under## [Unreleased]onmain— 15 entries either way, nothing reworded or dropped in the move.After merge
Tagging
v0.3.0fires the release workflow, which builds the binaries andpushes the Homebrew cask. That step is yours — I have not tagged anything.