Skip to content

fix: validate action metadata shape before inspecting runs (#670) - #720

Merged
Jamie-BitFlight merged 1 commit into
mainfrom
fix/670-action-metadata-guard
Oct 10, 2026
Merged

Jamie-BitFlight merged 1 commit into
mainfrom
fix/670-action-metadata-guard

Conversation

@Jamie-BitFlight

Copy link
Copy Markdown
Contributor

Fixes the verified TypeError for a non-object runs value. Parse YAML as unknown, check the runtime shape before using in, correct the validator's type predicate to the outer action metadata, and preserve the original load failure as cause.

Draft pending malformed-metadata regression tests and full repository CI. A separate follow-up should validate optional nested fields without rejecting valid GitHub Action metadata. Related #670.

@coderabbitai

coderabbitai Bot commented Oct 10, 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 59 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: 9dc4002b-92c1-45a0-80f7-4666e9e95100

📥 Commits

Reviewing files that changed from the base of the PR and between edb05b4 and 4dec063.


📒 Files selected for processing (1)
  • src/Action.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

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 92.14% 1009 / 1095
🔵 Statements 92.3% 1031 / 1117
🔵 Functions 95.03% 153 / 161
🔵 Branches 85.89% 554 / 645
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/Action.ts 92.85% 88.23% 100% 92.85% 141, 212, 239
Generated in workflow #1068 for commit 4dec063 by the Vitest Coverage Report Action

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 10, 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-10T21:15:47.999169Z 4dec063 Draft marked ready
ℹ️ 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.

@Jamie-BitFlight Jamie-BitFlight left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Holistic review of PRs #717–#728

Reviewed 4dec063ea5a6853e096d34f12b652a28df42a8ff against main at edb05b4eeea35e03df75b066b8ddd1d708de9f1c.

Assessment: the narrow runtime guard and cause preservation are correct; ready for final verification. No introduced runtime defect found.

On main, truthy scalar runs values such as runs: node24, runs: 42 and runs: true reach the in operator and throw TypeError. This head returns false and the constructor reports contextual invalid metadata while retaining the cause. Ordinary metadata and boolean/numeric/null input defaults remain accepted. Current-head Node 24/26, lint and both real-repository integration checks are green.

The predicate's ActionYaml type still overstates what has been checked: that model includes the internally supplied path, specific run variants and nested types. This is existing type-model debt, not evidence that raw YAML should be required to provide internal fields. If that model is corrected, describe the parsed guarantees separately; do not use it to justify the incompatible #727 restrictions.

#727 was reviewed only for its own additional nested-validation block. Keep this parent narrow; the child currently rejects supported metadata and must be corrected before restacking.

Comment thread src/Action.ts
@Jamie-BitFlight
Jamie-BitFlight merged commit c6caf7a into main Oct 10, 2026
11 checks passed
@Jamie-BitFlight
Jamie-BitFlight deleted the fix/670-action-metadata-guard branch October 10, 2026 23:12
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 📦🚀

@Jamie-BitFlight Jamie-BitFlight added the released This issue/pull request has been released. label Oct 11, 2026
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