Repository navigation
test: guard published CLI examples and retired email flag - #27
Merged
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
2 of 5 tasks
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.
Published email/song examples were not checked against the built CLI, and the retired
--room-idflag had no dedicated rejection guard. Add tests that extract examples and the chat-link option from an immutable, hash-verified Marketing guide, run the compiled entrypoint with synthetic credentials and intercepted requests, and assert request bodies or rejection before dispatch.No runtime, dependency, package version, or publishing workflow changes. Documentation owners can run the same check against a candidate guide using
RECOUP_CLI_REFERENCE_PATH; default coverage is the pinned guide, not future live docs or installed npm behavior.Validation: local build and all 82 tests across 13 files pass. Both deliberate mutations fail at the intended guard: changing the documented flag to
--room-id, and adding that retired alias to the compiled parser. Binary restored and five focused tests pass again. Local typecheck is blocked by missing Node declarations in the reused dependency tree; clean PR CI must verify it. Independent source review found no actionable issues; reviewer did not rerun builder checks.Hold before merge: merging main automatically bumps/publishes npm. This task authorizes preparing the candidate, not npm publication; coordinator must resolve that approval separately. Do not change publishing policy or retry registry publication as part of this PR.
Summary by cubic
Adds tests that run the published CLI examples from the hash-pinned Marketing guide against the compiled CLI with intercepted requests, with a dedicated guard for the retired
--room-idflag.dist/bin.cjswith a synthetic API key, asserts exact request bodies, and confirms--room-idis rejected before any request is sent.RECOUP_CLI_REFERENCE_PATHto run the same assertions against a candidate guide before publishing.Hold before merge: merging main automatically bumps and publishes npm, which this PR does not authorize; the coordinator must resolve that approval separately.
Written for commit aadc9cb. Summary will update on new commits.