Skip to content

fix: pair section log groups and honor Actions mode at output boundaries - #734

Merged
Jamie-BitFlight merged 5 commits into
mainfrom
fix/review-followup-logger-20261011
Oct 11, 2026
Merged

Jamie-BitFlight merged 5 commits into
mainfrom
fix/review-followup-logger-20261011

Conversation

@Jamie-BitFlight

@Jamie-BitFlight Jamie-BitFlight commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Why

The #728 review found reached group-lifecycle errors: an unstarted helper could close a caller's group, a thrown section could leave a group open, and repeated usage updates could overlap GitHub Actions' global group stream. Runtime tracing also found that GITHUB_ACTIONS=false still published four action outputs despite suppressing groups.

Changes

  • Track whether each LogTask actually opened a group, with idempotent completion.
  • Close every section's group in finally, preserving the original error.
  • Complete asynchronous usage-description preparation before opening the synchronous render/update group. Repeated usage remains accepted and preparation remains concurrent.
  • Remove dormant name-keyed formatting state and its implementation-only tests; document the supported lifecycle.
  • Apply exact-true Actions detection at existing output and diagnostic sites.
  • Cover real callers, native SVG failure, immediate SVG completion, cache/README failure ordering, and true/false/unset output behavior.

Dependency and scope

Commit ancestry is #732 → #733 → this PR; the PR targets main for the existing integration trigger. Own commit 2d45100 changes 16 additional files. Other changes are inherited, including both independently checked verifier corrections and the package completion assertion.

An actual three-way merge reproduced the adjacent Inputs.loadConfig conflict. This branch retains both nconf.Provider and the corrected Actions predicate.

Verification

The lifecycle regressions fail on 11 main behaviors; the output regression fails specifically in false mode. Corrected focused suites, native CLI cases and actual GITHUB_OUTPUT captures pass. A fresh independent re-review traced all production group openers and found no additional actionable defect. Restoring unconditional cleanup, parent usage ordering, missing synchronous cleanup or truthy output guards fails the intended behavioral assertions.

The complete combined snapshot passed canonical format/lint/type checks and JSON-reported coverage: 722 tests in 25 files, zero failed or skipped, including a fresh build and native packaged-entry tests.

At head 2d451006f5de39e2b9c370647e172e460c2590a4, unit/coverage CI passed 722 tests in 25 files in each named lane, plus checks, build and docs. Both external integrations passed the fresh package suite, exact README contract and convergence. Lint and both CodeQL analyses passed.

Both lanes actually ran Node 24.19.0. The shared setup action ignores the requested 26.x version after project detection succeeds. CI correction #735 now establishes execution of this complete application snapshot on actual Node 24.19.0 and Node 26.11.1. Both lanes pass 722 tests and coverage, checks, build and docs in run 38102235836; #735's only additional change is the setup action.

No generated bundles are committed. Independent runtime review and observed execution establish this assessment; job labels or unfinished bot reviews are not counted as completed verification. Follow-up to #717, #723 and closed #728.

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 13 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: bitflight-devops/github-action-readme-generator/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 730a2c00-82bc-49c8-8bc3-ab67b8c7b2ca

📥 Commits

Reviewing files that changed from the base of the PR and between 6fd3540 and 2d45100.


📒 Files selected for processing (24)
  • .github/workflows/integration-test.yml
  • __tests__/action.test.ts
  • __tests__/integration-bundled-binary.test.ts
  • __tests__/integration-readme-contract.test.ts
  • __tests__/logtask/index.test.ts
  • __tests__/logtask/lifecycle.test.ts
  • __tests__/save.test.ts
  • __tests__/update-branding.test.ts
  • package.json
  • scripts/verify-readme-contract.mjs
  • src/Action.ts
  • src/inputs.ts
  • src/logtask/README.md
  • src/logtask/index.ts
  • src/readme-editor.ts
  • src/readme-generator.ts
  • src/sections/update-badges.ts
  • src/sections/update-branding.ts
  • src/sections/update-contents.ts
  • src/sections/update-description.ts
  • src/sections/update-inputs.ts
  • src/sections/update-outputs.ts
  • src/sections/update-title.ts
  • src/sections/update-usage.ts

  • 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.

@github-actions

github-actions Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 94.05% 1012 / 1076
🔵 Statements 94.18% 1037 / 1101
🔵 Functions 96.95% 159 / 164
🔵 Branches 88.26% 564 / 639
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/Action.ts 95.91% 93.61% 100% 95.91% 224, 251
src/inputs.ts 94.28% 93.02% 100% 94.08% 371-376, 405-406, 841, 971, 1016-1021
src/readme-editor.ts 100% 97.72% 100% 100%
src/readme-generator.ts 100% 100% 100% 100%
src/logtask/index.ts 98.73% 97.01% 100% 98.73% 181
src/sections/update-badges.ts 100% 83.33% 100% 100%
src/sections/update-branding.ts 81.63% 70.37% 100% 81.63% 61, 68-76, 88, 95-97, 121-122, 178
src/sections/update-contents.ts 100% 94.44% 100% 100%
src/sections/update-description.ts 100% 50% 100% 100%
src/sections/update-inputs.ts 100% 93.75% 100% 100%
src/sections/update-outputs.ts 100% 91.66% 100% 100%
src/sections/update-title.ts 100% 75% 100% 100%
src/sections/update-usage.ts 100% 85.71% 100% 100%
Generated in workflow #1111 for commit 2d45100 by the Vitest Coverage Report Action

@Jamie-BitFlight
Jamie-BitFlight marked this pull request as ready for review October 11, 2026 00:41
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-11T01:23:23.770943Z 2d45100 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Preserve absent, empty, null, and multiline default distinctions in the exact README verifier. Exercise real YAML generation under both formatting settings and require corrupted default projections to fail.
Access nconf through its native default export and preserve configuration precedence. Build before native CLI and library contract tests, retain active coverage output, and run the fresh package suite before external integrations.

Capture the complete README when native import resolves so a pending write cannot pass the completion assertion by finishing during process shutdown.
Keep group ownership on the instance that opened it and close every synchronous section scope in finally. Prepare asynchronous usage descriptions before opening the rendering group, preserving concurrent preparation and repeated sections.

Apply exact-true Actions detection to existing output boundaries, remove unused group-format state, and cover native SVG failure, completion, error identity, and real caller lifecycle behavior.
@Jamie-BitFlight
Jamie-BitFlight force-pushed the fix/review-followup-logger-20261011 branch from ecf43b3 to 2d45100 Compare October 11, 2026 01:20
@Jamie-BitFlight
Jamie-BitFlight merged commit ceaa03a into main Oct 11, 2026
11 checks passed
@Jamie-BitFlight
Jamie-BitFlight deleted the fix/review-followup-logger-20261011 branch October 11, 2026 02:52
Jamie-BitFlight pushed a commit that referenced this pull request Oct 11, 2026
## [2.0.5](v2.0.4...v2.0.5) (2026-10-11)

### Bug Fixes

* add CLI-only generation error boundary ([#654](#654)) ([#725](#725)) ([6a27eaa](6a27eaa))
* **ci:** honor explicit Node versions before automatic detection ([95a9e68](95a9e68))
* **ci:** honor explicit Node versions in the test matrix ([#735](#735)) ([3f03f0d](3f03f0d))
* complete SVG writes before reporting success ([#717](#717)) ([170e499](170e499))
* consistently interpret GitHub Actions environment flag ([#670](#670)) ([#723](#723)) ([68756ad](68756ad))
* fail generation on formatting and requested save errors ([#654](#654)) ([#718](#718)) ([bb48434](bb48434))
* guard malformed runs metadata and preserve load error causes ([#720](#720)) ([c6caf7a](c6caf7a))
* load native ESM configuration and verify fresh package entry points ([5f92784](5f92784))
* load native ESM configuration and verify fresh package entry points ([#733](#733)) ([55746ed](55746ed))
* pair section log groups and honor Actions mode at output boundaries ([2d45100](2d45100))
* pair section log groups and honor Actions output mode ([#734](#734)) ([ceaa03a](ceaa03a))
* preserve empty metadata descriptions and cover reviewed errors ([3c0a181](3c0a181))
* preserve empty metadata descriptions and verify reviewed error paths ([#732](#732)) ([f8c0f4e](f8c0f4e))
* preserve original file read error as cause ([#722](#722)) ([05553e0](05553e0))
* validate consumed nested metadata descriptions ([#670](#670)) ([#729](#729)) ([330ab9a](330ab9a))
* validate README section configuration at input boundary ([#670](#670)) ([#726](#726)) ([40c9efd](40c9efd))
* verify declared defaults using their rendered projection ([beb2180](beb2180))
* verify empty metadata descriptions through the contract checker ([a5e2d31](a5e2d31))
@Jamie-BitFlight

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 2.0.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released This issue/pull request has been released.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant