docs(readme): document regression-canary use + required post-test state#99
Merged
hdamker merged 1 commit intocamaraproject:mainfrom Apr 23, 2026
Merged
Conversation
ReleaseTest is the target for the Validation Regression and Release Automation Regression canaries in camaraproject/tooling. Callers must leave the repository in a 'planned' state with an open Release Issue after any manual tests, otherwise the next RA canary run fails pre-check. Also updates Scope to reflect that the repo carries the Commonalities sample API templates as fixtures (not a minimal stub).
hdamker-bot
approved these changes
Apr 23, 2026
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
2 participants
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.
What type of PR is this?
documentation
What this PR does / why we need it:
Three small README updates to reflect the repository's expanded role since the Release Automation Regression canary (camaraproject/tooling#214 + follow-ups) and the Validation Regression canary went live:
plannedstate with an open Release Issue.code/API_definitions/as test fixtures".regression/r4.1-*+ their fixtures), the post-manual-test requirement, and therelease-review/*-preservedaccumulation side-effect.Which issue(s) this PR fixes:
Fixes #
Special notes for reviewers:
Documentation only — no workflow or code changes.
Changelog input
Additional documentation
This section can be blank.