Skip to content

ci: keep workflow and release-doc comments in step with the ruleset and pins (#2231) - #2249

Merged
JarryShaw merged 1 commit into
mainfrom
ci/2231-workflow-comment-drift
Oct 26, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
ci/2231-workflow-comment-drift

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • ci — CI configuration

Description

Closes #2231, and the releasing.rst part of #2228 (#2242 carries the rest).

  • cron-vendor.yml: the "Install and Setup" and "Commit changes" comments state current behaviour (design: write down what belongs in the all extra, and why #910, fix(ci): Vendor Update bumps for a new const module but never commits it #1685).
  • unit-tests.yml: the comment above required-checks lists Lint beside the Compat legs, as ruleset 23497679 requires.
  • action-gh-release: the pin is v3.0.3, so releasing.rst, cron-conda.yml and the test_release_tags_the_run_sha_1634 docstrings cite 3.0.3. create-release.yml drops the version, since its pin sits beside it. The v3.0.2...v3.0.3 diff changes only error handling.
  • test(project): verbatim text pins block fixing change-relative and wrong prose #2228: releasing.rst's :631-647 third-party line citation names release() instead, and its BARE_ELSEWHERE entry in test_unit_tests_queue.py goes.
  • YAML unchanged: create-release.yml, cron-conda.yml and unit-tests.yml load to equal data. cron-vendor.yml's comments sit inside run: strings, and with shell comment lines dropped it is equal too.
  • Fail-without-fix: the updated test_unit_tests_queue fails on origin/main ('631-647' … cites these bare).
  • Tests run: tests/project and the docstring contract give 2048 passed. actionlint is clean.

…nd pins (#2231)

- cron-vendor.yml: the "Install and Setup" and "Commit changes" comments
  state the current behaviour instead of change-relative history, keeping
  #910 and #1685 as references.
- unit-tests.yml: the comment above `required-checks` lists `Lint`, which
  ruleset 23497679 also requires.
- action-gh-release citations name 3.0.3, the pinned version (its
  src/github.ts differs from 3.0.2 only in error handling), or no version
  where the pin sits in the same file.

Also covers the releasing.rst item of #2228: the `:631-647` third-party
line citation becomes `release()`, and its BARE_ELSEWHERE entry in
test_unit_tests_queue is dropped.

Comments and docstrings only; every workflow loads to the same data
(modulo shell comment lines in cron-vendor's run blocks). tests/project
and test_docstring_contract pass; actionlint is clean.
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) ci Pull requests that change CI or workflow configuration (ci: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at f2c4f5653 (Sonnet).

  • YAML as data: create-release.yml, cron-conda.yml, unit-tests.yml and lint.yml load equal. cron-vendor.yml differs only in # lines inside two run: steps.
  • Ruleset 23497679: it requires Required checks passed, Compat Python 3.11–3.15 and Lint, which matches the new comment.
  • Upstream: the pin is v3.0.3 (efb35369…). The v3.0.2→v3.0.3 diff leaves util.ts, run.ts and action.yml identical, and v3.0.3 still exports release.
  • Fail-without-fix: test_unit_tests_queue fails on origin/main ('631-647' … cites these bare). The workflow selection gives 471 passed.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.56% (unit tier, Python 3.15, f2c4f5653, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 881 2618 867 92.11%
pcapkit/corekit 2589 74 816 37 96.51%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 2994 23 1038 25 98.81%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17433 218 4584 185 98.15%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at f2c4f5653. Closes #2231. With #2242 it also completes #2228, covering the releasing.rst line citation and its BARE_ELSEWHERE pin.

  • Review: Sonnet GOOD TO GO, first round. The YAML is unchanged as data, and the v3.0.3 upstream diff was checked.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed.
  • KTLO: 12 legs, no warnings.
  • Ordering: merged into main and run. project leg: 2353 tests, 0 failures.
  • Conflicts: none against the current main.

@JarryShaw
JarryShaw merged commit fcda765 into main Oct 26, 2026
70 checks passed
@JarryShaw
JarryShaw deleted the ci/2231-workflow-comment-drift branch October 26, 2026 14:53
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Pull requests that change CI or workflow configuration (ci: subject prefix) docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

ci(workflows): comments drift from the ruleset, the action-gh-release pin and the no-timed-context rule

1 participant