Slipstream/auto_review
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases 27 Packages Activity Actions

test(docs): remove prose wording checks #181

Merged
jwilger merged 1 commit from issue-134-docs-test-guidance into main 2026-05-10 08:06:39 -07:00
Conversation 1 Commits 1 Files changed 6 +17 -303
jwilger commented 2026-05-10 07:58:11 -07:00
Owner
Copy link

Summary

  • Remove release-tooling tests that asserted operator/threat-model prose wording for docs-only content.
  • Keep executable release workflow and changelog marker checks, and clarify that the CLI docs test covers only the public subcommand surface.
  • Update contributor/test guidance to steer docs-only prose changes toward human/operator review and require justification near legitimate docs-reading contract tests.

Verification

  • bash tests/release_tooling/docs_secrets_test.sh
  • bash tests/release_tooling/release_script_flake_test.sh
  • bash tests/release_tooling_test.sh
  • cargo fmt --all -- --check
  • cargo nextest run -p ar-cli readme_documents_every_subcommand

Closes #134

PR artifacts for f41cd6264a:

Docker image: git.johnwilger.com/jwilger/auto_review/ar-gateway-pr:pr-181-f41cd6264afa4efec2bdc0c70e25561a1db60327
binary download: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/181-f41cd6264afa4efec2bdc0c70e25561a1db60327/auto-review-pr-181-f41cd6264afa4efec2bdc0c70e25561a1db60327-linux-x86_64.tar.gz
SHA256SUMS: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/181-f41cd6264afa4efec2bdc0c70e25561a1db60327/SHA256SUMS

## Summary - Remove release-tooling tests that asserted operator/threat-model prose wording for docs-only content. - Keep executable release workflow and changelog marker checks, and clarify that the CLI docs test covers only the public subcommand surface. - Update contributor/test guidance to steer docs-only prose changes toward human/operator review and require justification near legitimate docs-reading contract tests. ## Verification - `bash tests/release_tooling/docs_secrets_test.sh` - `bash tests/release_tooling/release_script_flake_test.sh` - `bash tests/release_tooling_test.sh` - `cargo fmt --all -- --check` - `cargo nextest run -p ar-cli readme_documents_every_subcommand` Closes #134 <!-- auto_review:artifact-links:start --> PR artifacts for f41cd6264afa4efec2bdc0c70e25561a1db60327: Docker image: git.johnwilger.com/jwilger/auto_review/ar-gateway-pr:pr-181-f41cd6264afa4efec2bdc0c70e25561a1db60327 binary download: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/181-f41cd6264afa4efec2bdc0c70e25561a1db60327/auto-review-pr-181-f41cd6264afa4efec2bdc0c70e25561a1db60327-linux-x86_64.tar.gz SHA256SUMS: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/181-f41cd6264afa4efec2bdc0c70e25561a1db60327/SHA256SUMS <!-- auto_review:artifact-links:end -->
test(docs): remove prose wording checks
All checks were successful
CI / Verify PR with nix flake check (pull_request) Successful in 3m25s
Details
CI / Request auto_review semantic review (pull_request) Successful in 2s
Details
auto_review auto_review: no findings
CI / Build PR artifacts (no token) (pull_request) Successful in 1m35s
Details
CI / Publish PR artifact packages (pull_request) Successful in 1m7s
Details
Clean PR packages / Delete packages for merged PRs (pull_request) Successful in 15s
Details
f41cd6264a
 
Stop treating prose-only documentation changes as deterministic test contracts while keeping executable release tooling and CLI surface checks documented.
auto-review approved these changes 2026-05-10 08:01:47 -07:00
auto-review left a comment
Copy link

This PR removes tests that enforced specific wording in documentation, focusing instead on executable behavior and public contracts. The changes streamline the testing process and clarify contributor guidelines. The PR appears safe to merge.

This PR removes tests that enforced specific wording in documentation, focusing instead on executable behavior and public contracts. The changes streamline the testing process and clarify contributor guidelines. The PR appears safe to merge.
Sign in to join this conversation.
Reviewers
No reviewers
auto-review
Labels
Clear labels   
bug

   
discussion

   
enhancement
  
bug
Something is not working

  
duplicate
This issue or pull request already exists

  
enhancement
New feature

  
help wanted
Need some help

  
invalid
Something is wrong

  
question
More information is needed

  
wontfix
This won't be fixed

No labels
bug
discussion
enhancement
bug
duplicate
enhancement
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Slipstream/auto_review!181
No description provided.