Skip to content

docs(repo): the patch arm's name rule, the tasks check flag and host record, both new arms in the README - #199

Merged
antonwolfy merged 2 commits into
intel:mainfrom
antonwolfy:docs/repo-contract-leftovers
Oct 26, 2026
Merged

antonwolfy merged 2 commits into
intel:mainfrom
antonwolfy:docs/repo-contract-leftovers

Conversation

@antonwolfy

@antonwolfy antonwolfy commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Doc points from the reviews of #117 and #112 that were still open when they merged. xaleryb and napetrov had also left the README row "still open for the author" on #117. Only docs change.

Changes

  • The patch: arm's name (thread on #117). The contract said every character outside [A-Za-z0-9.-] becomes _. parse_arm does more:

    • each run of such characters becomes one _;
    • a leading or trailing _ is dropped;
    • the result is cut to 40 characters, and a _ the cut leaves at the end is dropped too.

    So my fix (v2).diff is my_fix_v2_.diff. The paragraph's 130-character line is re-wrapped.

  • README (#117 review): the arm table lists guidance:rev:<rev> and patch:<file> next to guidance:none|raw|bridge.

  • repo tasks check (#112 review):

    • the S5 usage line has [--allow-unsupported];
    • the self-check example's "exits 1 if any task is broken or unsupported" gets the exception;
    • §4.3 names where the host probe's facts go: check.json host, and the batch's _eval/host.json for repo run.

Risk

None to behaviour. #176 rewrote the same two places of repo-evaluation-contract.md; f83a489 merges main after it and keeps both edits. The --allow-unsupported paragraph has #176's "unless no task is ok (below)" and this PR's sentence on where the probed host facts go. The tasks check example comment has #176's "or none is ok" and this PR's note that a task this host cannot run does not fail the check on its own.

Testing

On a Linux review host, at 2140faf (on main 506f7ba):

Checklist

  • Tests added/updated and pytest passes
  • ruff, mypy, and schema checks pass
  • Docs updated (or N/A) — see the docs-drift checklist in CONTRIBUTING.md
  • No ad-hoc run artifacts committed
  • New files carry the SPDX license header (or are exempt in .github/.licenserc.yaml)

…record, both new arms in the README

Leftovers from the reviews of intel#117 and intel#112:
- The contract said every character outside [A-Za-z0-9.-] becomes `_`.
  The code turns each run into one `_`, drops a leading or trailing `_`
  and cuts at 40, so `my fix (v2).diff` is `my_fix_v2_.diff`. Also re-wrap
  the paragraph's 130-character line.
- The S5 usage of `repo tasks check` lacked `--allow-unsupported`, and the
  example's "exits 1 if any task is unsupported" had no exception for it.
- §4.3 names where the host probe's facts go: `check.json` `host` and the
  batch's `_eval/host.json`.
- The README's arm table lists `guidance:rev:<rev>` and `patch:<file>`.

Signed-off-by: Anton Volkov <antonwolfy@gmail.com>
@vchamarthi

Copy link
Copy Markdown
Contributor

@exai-bot /review

@exai-bot exai-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Note

AI-generated review of dd218a993352, requested by @vchamarthi, using the default review skill. It can be wrong: verify a finding before acting on it. React with a thumbs up or down on a finding to tell the bot whether it helped.
Model us.anthropic.claude-sonnet-5-5, effort default, 3 of 80 turns, 0.2 of 40 minutes, 39k in / 925 out tokens.

Docs-only change. It corrects the patch: arm's name rule, adds [--allow-unsupported] to the repo tasks check usage and example, records where the host probe's facts go, and lists the two new arms in the README table. I checked each claim against the code and found no discrepancies.

No issues found.

Not verified

I traced the my fix (v2).diff → my_fix_v2_.diff example by hand through the regex in parse_arm. I did not run it.

@codecov-commenter

codecov-commenter commented Oct 23, 2026 •

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.28%. Comparing base (51f2899) to head (f83a489).
⚠️ Report is 1 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #199   +/-   ##
=======================================
  Coverage   92.28%   92.28%           
=======================================
  Files         239      239           
  Lines       29969    29969           
  Branches     4929     4929           
=======================================
  Hits        27657    27657           
  Misses       1630     1630           
  Partials      682      682           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@napetrov napetrov 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.

Docs corrections look right. As noted in Risk, #176 touches the same example line in repo-evaluation-contract.md; let's agree which lands first so the second rebases once.

@napetrov napetrov 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.

Read the diff: the patch-arm name rule now matches parse_arm, the README lists both new arms, and the --allow-unsupported/host-record notes are right. LGTM; just sequence with #176.

@antonwolfy

Copy link
Copy Markdown
Contributor Author

@napetrov agreed. #176 is the larger change, so let it land first. I'll rebase #199 right after; the conflict is the one example comment line.

intel#176 and this branch edit the same two places of
repo-evaluation-contract.md. Both kept:

- the --allow-unsupported paragraph has intel#176's "unless no task is ok
  (below)" and this branch's sentence on where the probed host facts are
  recorded, re-wrapped at 80 columns;
- the tasks check example comment has intel#176's "or none is ok", and this
  branch's note that with --allow-unsupported a task this host cannot run
  does not fail the check on its own.

Signed-off-by: Anton Volkov <antonwolfy@gmail.com>
@antonwolfy

Copy link
Copy Markdown
Contributor Author

@napetrov #176 is in, so I merged main into this branch (f83a489) instead of rebasing: the branch needed no force push, and the PR is squash-merged either way. Both places that conflicted in repo-evaluation-contract.md keep #176's wording and this PR's addition:

make ci-local passes at f83a489: 29 passed, 0 failed, 7 skipped.

@antonwolfy
antonwolfy merged commit daa6ea8 into intel:main Oct 26, 2026
16 checks passed
@antonwolfy
antonwolfy deleted the docs/repo-contract-leftovers branch October 26, 2026 13:19
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.

5 participants