Skip to content

docs(action): fix input and output descriptions in action.yml#835

Open
kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
kranthipoturaju:docs/fix-action-yml-input-output-descriptions
Open

docs(action): fix input and output descriptions in action.yml#835
kranthipoturaju wants to merge 1 commit intowagoid:masterfrom
kranthipoturaju:docs/fix-action-yml-input-output-descriptions

Conversation

@kranthipoturaju
Copy link
Copy Markdown

Summary

Corrects inaccurate and incomplete documentation in action.yml without changing any runtime behavior.

Changes

  • configFile: Added an explicit note that the .js extension is not supported and causes a hard failure — users must use .mjs instead.
  • failOnErrors: Changed required: true to required: false. The field has a default value of "true", making required: true semantically 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.
  • results output: Replaced the vague description ("error and warning messages") with the actual JSON schema — an array of objects each containing hash, message, valid, errors, and warnings.

Motivation

The previous descriptions were either incorrect (required: true on a field with a default), missing critical constraints (.js not allowed for configFile), or too vague to be useful (results output structure). Users relying solely on action.yml for integration would hit confusing failures or not know how to consume the results output.

Impact

  • No behavior changes — documentation only.
  • Backward compatible: no input or output names were changed.
  • The required: false fix on failOnErrors has 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.mjs and src/generateOutputs.mjs.

Copilot AI review requested due to automatic review settings April 29, 2026 18:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 configFile constraints (notably .js not supported).
  • Fixes failOnErrors to be required: false to align with its default.
  • Expands commitDepth and results output descriptions to be more explicit.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread action.yml Outdated
Comment thread action.yml Outdated
@kranthipoturaju kranthipoturaju force-pushed the docs/fix-action-yml-input-output-descriptions branch from e403f84 to 5607a8e Compare April 29, 2026 19:13
@kranthipoturaju kranthipoturaju requested a review from Copilot April 29, 2026 19:14
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 configFile constraint that .js is rejected and .mjs must be used.
  • Fixes failOnErrors metadata by making it non-required while retaining the existing default.
  • Expands docs for commitDepth edge cases and the results output structure.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread action.yml Outdated
Comment thread action.yml Outdated
Comment thread action.yml Outdated
@kranthipoturaju kranthipoturaju force-pushed the docs/fix-action-yml-input-output-descriptions branch from 0674423 to 920bde4 Compare April 29, 2026 19:24
@kranthipoturaju kranthipoturaju requested a review from Copilot April 29, 2026 19:24
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 configFile constraint that .js configs hard-fail and .mjs must be used.
  • Corrects failOnErrors metadata by setting required: false since a default is provided.
  • Expands commitDepth and results output descriptions to reflect actual behavior/output schema.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants