Skip to content

State the Install-Tools JSON Report in the Host Contract - #2267

Merged
ptr727 merged 1 commit into
developfrom
feature/host-setup-json-report
Oct 1, 2026
Merged

ptr727 merged 1 commit into
developfrom
feature/host-setup-json-report

Conversation

@ptr727

@ptr727 ptr727 commented Oct 1, 2026

Copy link
Copy Markdown
Owner

Summary

Copilot's review of promotion PR #2254 raised a "previously missed" finding against #2259's install-tools JSON report. add-host-tool's procedure says a change to report behavior must update docs/host-setup.md as well as the platform READMEs, and #2259 updated only the READMEs.

docs/host-setup.md now has one paragraph saying:

  • the flags are --report --json on Linux and -Report -Json on Windows, and the JSON flag applies to no other action;
  • the output is one object with a schema number, the platform, a tools list, and a top-level notes list;
  • a change to what a field means raises schema.

For the shared fields it links to the Linux README, and for its one added field and the values that differ it links to the Windows README. It doesn't restate them, so a third copy of the field list can't drift.

Verification

  • local-strict-review checked each claim against both installers and both READMEs and found nothing. Its receipt is recorded.
  • prose_lint --diff origin/develop, docker_lint.py (markdownlint, cspell, editorconfig), and spec/validate.py are all clean. The full unittest discover run passes.

🤖 Generated with Claude Code

add-host-tool's procedure has a report-behavior change update
docs/host-setup.md beside the platform READMEs, and #2259 updated only the
READMEs. The contract now names both flags, that they apply only to the
report action, the shared top-level shape, and that a change to a field's
meaning raises schema, and it routes to the Linux README for the shared
fields and the Windows README for its one addition rather than restating
them. Copilot raised it on promotion #2254.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 1, 2026 23:14
@coderabbitai

coderabbitai Bot commented Oct 1, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Repository: ptr727/ProjectTemplate/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 93b69851-4f8c-45e7-a78b-48f7e20fd088

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.31%. Comparing base (18be0e9) to head (9888e89).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2267   +/-   ##
========================================
  Coverage    57.31%   57.31%           
========================================
  Files           16       16           
  Lines         7611     7611           
========================================
  Hits          4362     4362           
  Misses        3249     3249           
Flag Coverage Δ
python-3.13 57.31% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The Windows JSON output omits a documented report-level warning, and the new prose exceeds the sentence-length limit.

Review effort: Lite
Findings: 1 High severity

Open (1)
What changed in this PR

Documents the install-tools JSON report contract in the central host setup guide.

Changes:

  • Defines JSON flags, schema, report structure, and notes.
  • Links shared and platform-specific field details.
File Summary
docs/​host-setup.md Documents the shared JSON report contract and platform references.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/host-setup.md
@ptr727
ptr727 merged commit 3fec4f8 into develop Oct 1, 2026
11 checks passed
@ptr727
ptr727 deleted the feature/host-setup-json-report branch October 1, 2026 23:18
ptr727 added a commit that referenced this pull request Oct 2, 2026
…#2254)

## Summary

Promotes develop to main, carrying the pull requests below. Each was
already reviewed and merged into develop.

- [#2253](#2253): Track
Qodo's open-source login and state its star gate.
- [#2259](#2259): Give
install-tools a JSON report mode a program can read. Copilot could not
review it, since Copilot code review has reached its weekly rate limit
(#2261). CodeRabbit reviewed its head with no findings, and recorded
local passes covered every push.
- [#2263](#2263): Declare
Python and Codecov on Blog's registry entry.
- [#2265](#2265): Keep the
fork iteration PR open and never merged in
`upstream-contribution-workflow`, and let an unregistered fork under the
owner host a handoff chain, with `handoff.py new --create-label`
creating only the `handoff` label there.
- [#2266](#2266): Bound
`handoff.py`'s writes whatever the label state, refusing `new` and
`link` against another owner's repository, or an unregistered non-fork,
before the label is read. This answers Copilot's High finding on this
promotion.
- [#2267](#2267): State
the install-tools JSON report in `docs/host-setup.md`, answering
Copilot's previously-missed finding on #2259's report mode.
- [#2269](#2269): Drop two
false pointers from Blog's deploy-secret drift note, and recast every
semicolon in the registry's driftNotes, answering Copilot's
previously-missed finding on #2263's note.

With the open-source login tracked, `qodo_open` double-counts that app's
threaded findings and never clears them on PlexCleaner. That is a known,
loud error, accepted for this promotion and tracked in #2252.

Closes #1465
Closes #1645
Closes #2264

🤖 Generated with [Claude Code](https://claude.com/claude-code)


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Clarified which review commands to use when a reviewer posts a skip
notice.
* Updated reviewer evaluation guidance to reflect when CodeRabbit and
Qodo findings are recorded, including Qodo’s repository eligibility
requirements.
* **Bug Fixes**
* Updated Qodo reviewer tracking to recognize its current open-source
app identity, improving how its reviews and findings are identified.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.

2 participants