Skip to content

Docs and tests: generic wording - #2

Merged
danbarker merged 1 commit into
mainfrom
generic-fixtures-and-wording
Nov 14, 2026
Merged

danbarker merged 1 commit into
mainfrom
generic-fixtures-and-wording

Conversation

@danbarker

@danbarker danbarker commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Two wording fixes: a test comment now describes a config-management tool supplying the key in general terms, and a stray plan label is dropped from docs/exposure-modes.md. No behaviour change. bundle exec rake test: 336 runs, 0 failures.
🤖 Generated with Claude Code


Note

Low Risk
Comment and documentation edits only; no logic, configuration, or API changes.

Overview
This PR is wording-only: no runtime or test behavior changes.

docs/exposure-modes.md — The IP-mode trade-off note no longer mentions the internal SP5 plan label; it still says Matron apps need pinned-certificate trust before self-signed TLS is seamless for everyone.

test/matron_module_test.rb — The comment above test_openai_key_line_renders_from_secrets_yml now describes any config-management tool merging the OpenAI key into secrets.yml, instead of naming Chef and a “production path.”

Reviewed by Cursor Bugbot for commit 0f57906. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Clarified that clients must support self-signed certificates to connect until pinned-certificate trust is available in Matron apps.
  • Tests
    • Updated test commentary to describe configuration management more generally; test behaviour is unchanged.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 14, 2026

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The changes revise the certificate-trust wording in the exposure-mode documentation and generalise a comment in a Matron module test. The test code is unchanged.

Changes: Documentation and test wording

Layer / File(s) Summary
Clarify the certificate trust limitation
docs/exposure-modes.md
The trade-off no longer names SP5. It retains the limitation that clients must accept a self-signed certificate until Matron apps support pinned-certificate trust.
Generalise the configuration-management comment
test/matron_module_test.rb
The comment describes a configuration-management tool merging the key into secrets.yml, replacing the specific Chef and file path references.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: Minimal · up to 0f579

This change only rewords documentation and a test comment. It does not alter runtime behavior, and the risk of merging is minimal.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Docs and tests: generic wording" matches the changeset. The PR removes the SP5 plan label from a note in docs/exposure-modes.md and rewords a test comment to refer to a generic config-manag…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "Docs and tests: generic wording" matches the changeset. The PR removes the SP5 plan label from a note in docs/exposure-modes.md and rewords a test comment to refer to a generic config-management tool instead of Chef. The title names both areas and the common theme. It is brief and specific enough for a teammate to understand the main change. It does not name the specific edits, but that level of detail is not required.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 0e2e4ba and 0f57906.

Files selected for processing: 2

  • docs/exposure-modes.md
  • test/matron_module_test.rb

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@danbarker
danbarker merged commit 2b48aad into main Nov 14, 2026
3 checks passed
@danbarker
danbarker deleted the generic-fixtures-and-wording branch November 14, 2026 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant