Repository navigation
Split the Over-Length Comment Sentences in the Spec Scripts and Workflows - #3611
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
|
A recorded local strict-review pass covers head |
There was a problem hiding this comment.
🟡 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
Codecov Report✅ All modified and coverable lines are covered by tests. 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
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:
|
|
A recorded local strict-review pass covers head |
|
A recorded local strict-review pass covers head |
…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)

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 insiderun:bodies ofbuild-release-task.yml,canonical-review-sweep.yml, andvalidate-task.yml. No key, value, expression,description:string, or executable line changed.actionlintpasses on all workflows.Verification:
prose_lint --check sentence-lengthreads 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.pypasses. 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 adocs/host-setup.mdsentence that already reads zero. JSON is outside this slice.Notes
run:bodies were edited because they are comments only. The brief asked for byte-identicalrun:bodies, so say if that should have been left.🤖 Generated with Claude Code