Repository navigation
Conversation
Adds a paragraph to `host-setup/linux/README.md` "GitHub Setup" and to `host-setup/windows/README.md` naming the gh SSH protocol opt-in (`--gh-ssh-protocol`, `-GhSshProtocol`): reported by default, set only on the opt-in, and a warning with nothing set where gh is absent or not logged in. Wording checked against both setup-github scripts and `docs/host-setup.md` "GitHub CLI". Closes on promotion: #2590 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
|
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 |
There was a problem hiding this comment.
🟢 Approval recommended
Both documentation additions match the existing setup behavior, and no issues were identified.
0 open findings
What changed in this PR
This promotion brings the gh SSH protocol opt-in documentation from develop to main in both host-setup READMEs.
Changes:
- Explain that setup reports the protocol by default and changes it only when the opt-in is used.
- Note that the opt-in warns and sets nothing if gh is missing or not logged in.
| File | Description |
|---|---|
| host-setup/windows/README.md | Documents -GhSshProtocol and its prerequisites. |
| host-setup/linux/README.md | Documents --gh-ssh-protocol and its prerequisites. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2645 +/- ##
=======================================
Coverage 59.34% 59.34%
=======================================
Files 16 16
Lines 8282 8282
=======================================
Hits 4915 4915
Misses 3367 3367
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Promotes the one change develop holds over main: the Linux and Windows host setup READMEs now name the gh SSH protocol opt-in (
--gh-ssh-protocol,-GhSshProtocol), covering that the protocol is reported by default, set only on the opt-in, and left unset with a warning where gh is absent or not logged in (#2644).Fixes #2590
🤖 Generated with Claude Code