Skip to content

Split the Over-Length Comment Sentences in the Spec Scripts and Workflows - #3611

Merged
ptr727 merged 9 commits into
developfrom
feature/3531-cmt-spec-workflows
Oct 29, 2026
Merged

ptr727 merged 9 commits into
developfrom
feature/3531-cmt-spec-workflows

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

Part of #3531

Splits the over-length sentences in comments, docstrings, and workflow comments in the spec scripts, the reusable workflows and composite actions, and their tests. Meaning is unchanged. Only comment and docstring text differs, plus shell # comment lines inside run: bodies of build-release-task.yml, canonical-review-sweep.yml, and validate-task.yml. No key, value, expression, description: string, or executable line changed. actionlint passes on all workflows.

Verification: prose_lint --check sentence-length reads zero on every changed file. tests/test_spec_validate.py, tests/test_release_guards.py, tests/test_docker_task_workflow.py, and the full unittest discovery pass. python3 spec/validate.py passes. A recorded local adversarial pass (opus) ran over the final content with no findings, after three earlier passes' findings were fixed.

Copies left for the comment sweep

  • spec/host-tools.json (the entry near line 55) pairs with a docs/host-setup.md sentence that already reads zero. JSON is outside this slice.

Notes

  • Shell comment lines inside workflow run: bodies were edited because they are comments only. The brief asked for byte-identical run: bodies, so say if that should have been left.

🤖 Generated with Claude Code

ptr727 and others added 4 commits October 29, 2026 08:34
…lows

Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 29, 2026 15:48
@ptr727 ptr727 added the comments Permits the comment lines the pull request adds or edits, which the prose gate otherwise refuses label Oct 29, 2026
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

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

Run configuration
  • 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

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

@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 5ce6b58b8cad1f9037d6d7de2740d8baddf2a9a6, the content this pull request carries at that commit against develop, and it recorded 0 findings.

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.

🟡 Changes recommended

Two active nit findings remain because comments in the workflow and validation code are split into incomplete, grammatically unclear explanations.

2 open issues
What changed in this PR

This pull request splits over-length comments and docstrings across specification scripts, tests, reusable workflows, and composite actions. It preserves executable behavior, workflow configuration, expressions, and values.

Changes:

  • Reflows long Python comments and docstrings.
  • Splits workflow and composite-action comments, including shell comments inside selected run: blocks.
  • Converts lengthy explanations into shorter sentences and structured lists.
File Review notes
tests/​workflow_steps.py No final comments.
tests/​test_spec_validate.py No final comments.
tests/​test_release_guards.py No final comments.
tests/​test_docker_task_workflow.py No final comments.
spec/​workflow_reuse.py No final comments.
spec/​validate.py Nit, line 82, 3 votes: complete the required-secret grammar explanation. Nit, line 164, 1 vote: keep each comment sentence on one line.
spec/​resolve_description.py No final comments.
spec/​git_env.py No final comments.
spec/​fidelity_honesty.py No final comments.
spec/​audit.py No final comments.
.github/​workflows/​validate-task.yml No final comments.
.github/​workflows/​run-codegen-pull-request-task.yml No final comments.
.github/​workflows/​publish-docker-readme-task.yml No final comments.
.github/​workflows/​get-version-task.yml No final comments.
.github/​workflows/​deploy-site-task.yml Nit, line 10, 1 vote: use the repository’s # - comment-bullet form instead of # -.
.github/​workflows/​check-upstream-version-task.yml Nit, line 6, 1 vote: use the repository’s # - comment-bullet form instead of # -.
.github/​workflows/​canonical-review-sweep.yml Nit, lines 39 and 68, 1 vote each: use the repository’s # - comment-bullet form instead of # -.
.github/​workflows/​build-release-task.yml No final comments.
.github/​workflows/​build-docker-task.yml Nit, line 123, 4 votes: keep the matrix explanation as complete comment sentences and avoid the ungrammatical fragment.
.github/​actions/​validate/​action.yml No final comments.
.github/​actions/​validate-default/​action.yml No final comments.
.github/​actions/​pypi-build-default/​action.yml No final comments.
.github/​actions/​nuget-build-default/​action.yml No final comments.

Review effort: Lite

Comment thread .github/workflows/build-docker-task.yml Outdated
Comment thread spec/validate.py Outdated
@codecov

codecov Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.60%. Comparing base (b38e084) to head (3927704).
⚠️ Report is 8 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3611   +/-   ##
========================================
  Coverage    81.60%   81.60%           
========================================
  Files           26       26           
  Lines         9070     9070           
========================================
  Hits          7402     7402           
  Misses        1668     1668           
Flag Coverage Δ
python-3.13 81.60% <ø> (ø)

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.

ptr727 and others added 2 commits October 29, 2026 08:58
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 7e86656ee7c509930d3351a0cb6cf7d86abb6371, the content this pull request carries at that commit against develop, and it recorded 2 findings.

ptr727 and others added 3 commits October 29, 2026 09:24
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 3927704d1bba5a5ccb476aee5ec2194713af6958, the content this pull request carries at that commit against develop, and it recorded 0 findings.

@ptr727
ptr727 merged commit 5ddc72c into develop Oct 29, 2026
13 checks passed
ptr727 added a commit that referenced this pull request Oct 29, 2026
…tence-length a Default Check (#3619)

Promotes the #3531 comment sweep and its default flip from `develop` to
`main`.

- [#3603](#3603) Moves the
dispatch-refresh note out of the Docker clause in
branching-and-release-model.
- [#3606](#3606) Splits
over-length comment sentences in pr_review and host_gate.
- [#3607](#3607) Splits
over-length comment sentences in the local and canonical review engines.
- [#3608](#3608) Splits
over-length comment sentences in build_dist, carry, handoff, and
skills_install.
- [#3609](#3609) Splits
over-length comment sentences in the prose and repo gates.
- [#3611](#3611) Splits
over-length comment sentences in the spec scripts and workflows.
- [#3612](#3612) Splits
over-length comment sentences in the host install scripts.
- [#3613](#3613) Splits
over-length comment sentences in the host menu, bootstrap, and setup
scripts.
- [#3615](#3615) Splits
over-length comment sentences in the agent-safety kit, repo config, and
snippets.
- [#3618](#3618) Makes
`sentence-length` a default prose gate check.

Closes #3531
Closes #3588

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@ptr727
ptr727 deleted the feature/3531-cmt-spec-workflows branch October 29, 2026 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comments Permits the comment lines the pull request adds or edits, which the prose gate otherwise refuses

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants