docs(zapier): add the changelog promote requires, correct the env note - #4
Merged
Conversation
`zapier promote` hard-fails without a CHANGELOG.md entry for the version being promoted — it blocked the 1.1.0 release until the file existed. The changelog is user-facing (Zapier shows it to people using the integration), and Zapier parses it: lines beginning with Update or Fix, with identifiers of the form <trigger|create|search>/<key>. All eight operations that expose a Base dropdown are named for that reason. Also corrects the release note added in the previous commit. It claimed env does not follow a version bump; the 1.0.0 -> 1.1.0 push carried CLIENT_ID, CLIENT_SECRET and TEABLE_INSTANCE_URL onto the new version on its own. Checking with env:get before promoting is still worth the two seconds — a version promoted without CLIENT_ID breaks OAuth for everyone — but the claim as written was wrong. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Follow-up to #3, from actually running the 1.1.0 release.
promoterequires a CHANGELOGzapier promote 1.1.0failed outright:The repo had no
CHANGELOG.md, so this blocked the release until one existed. Adding it, with entries for 1.1.0 and 1.0.0.It is user-facing — Zapier shows it to people using the integration — and Zapier parses it. Lines beginning with
UpdateorFixare extracted, and identifiers of the form<trigger|create|search>/<key>are linked to operations. The 1.1.0 entry names all eight operations that expose a Base dropdown, which Zapier picked up correctly:Correcting the env note from #3
#3 added a release section claiming env does not follow a version bump. That is wrong: the CI push of 1.1.0 carried
CLIENT_ID,CLIENT_SECRETandTEABLE_INSTANCE_URLonto the new version without any intervention.env:getbefore promoting is still worth doing — promoting a version with noCLIENT_IDbreaks OAuth for everyone — but as a cheap confirmation, not because the values are expected to be missing.Release status
1.1.0 is promoted and the migration from 1.0.0 completed. This PR only adds files the release process needs; nothing here changes integration behaviour.
🤖 Generated with Claude Code