docs(action): fix input and output descriptions in action.yml#835
docs(action): fix input and output descriptions in action.yml#835kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Action metadata (action.yml) to better document existing behavior for inputs/outputs, improving usability without altering runtime logic.
Changes:
- Clarifies
configFileconstraints (notably.jsnot supported). - Fixes
failOnErrorsto berequired: falseto align with its default. - Expands
commitDepthandresultsoutput descriptions to be more explicit.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
e403f84 to
5607a8e
Compare
There was a problem hiding this comment.
Pull request overview
Updates action.yml documentation to more accurately describe action inputs/outputs (no runtime behavior changes), improving usability for workflow authors integrating the action.
Changes:
- Clarifies
configFileconstraint that.jsis rejected and.mjsmust be used. - Fixes
failOnErrorsmetadata by making it non-required while retaining the existing default. - Expands docs for
commitDepthedge cases and theresultsoutput structure.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
0674423 to
920bde4
Compare
There was a problem hiding this comment.
Pull request overview
Updates the GitHub Action metadata documentation in action.yml to accurately describe supported inputs and the structure of the results output, aligning the YAML with the current implementation (no runtime logic changes).
Changes:
- Clarifies
configFileconstraint that.jsconfigs hard-fail and.mjsmust be used. - Corrects
failOnErrorsmetadata by settingrequired: falsesince a default is provided. - Expands
commitDepthandresultsoutput descriptions to reflect actual behavior/output schema.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Corrects inaccurate and incomplete documentation in
action.ymlwithout changing any runtime behavior.Changes
configFile: Added an explicit note that the.jsextension is not supported and causes a hard failure — users must use.mjsinstead.failOnErrors: Changedrequired: truetorequired: false. The field has a default value of"true", makingrequired: truesemantically contradictory per the GitHub Actions spec.commitDepth: Extended the description to document that zero, negative, and non-numeric values are silently ignored and all commits are linted.resultsoutput: Replaced the vague description ("error and warning messages") with the actual JSON schema — an array of objects each containinghash,message,valid,errors, andwarnings.Motivation
The previous descriptions were either incorrect (
required: trueon a field with a default), missing critical constraints (.jsnot allowed forconfigFile), or too vague to be useful (resultsoutput structure). Users relying solely onaction.ymlfor integration would hit confusing failures or not know how to consume theresultsoutput.Impact
required: falsefix onfailOnErrorshas no runtime effect since the field already carries a default; it only corrects how tooling and UIs surface the field.Testing
No code paths were modified. Changes were validated by cross-referencing each field against the source implementation in
src/action.mjsandsrc/generateOutputs.mjs.