Skip to content

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

Merged
stefanzweifel merged 2 commits into
stefanzweifel:masterfrom
kranthipoturaju:docs/fix-action-yml-descriptions
May 7, 2026
Merged

docs(action): fix input and output descriptions in action.yml#406
stefanzweifel merged 2 commits into
stefanzweifel:masterfrom
kranthipoturaju:docs/fix-action-yml-descriptions

Conversation

@kranthipoturaju
Copy link
Copy Markdown
Contributor

Summary

Fixes several inaccuracies and omissions in action.yml input and output descriptions to better reflect actual runtime behavior.

Changes

  • file_pattern: Description now states the pattern is applied to both git add and the git status dirty-check, and that multiple space-separated patterns are supported.
  • required: false: Added to disable_globbing, create_branch, and internal_git_binary, which were the only inputs missing this field.
  • changes_detected output: Rewritten to cover the CRLF-only edge case (where git diff --staged yields no diff after staging, resetting the value to "false") and to note the output is absent in create_git_tag_only mode.
  • commit_hash output: Clarified that it is only set when a commit is actually created, not merely when changes are detected.
  • create_git_tag_only output: Clarified it is only ever set to "true" and is absent (not "false") in normal commit flow.

Motivation

The previous descriptions were misleading in a few ways:

  • file_pattern implied it only affected git add, leading users to expect untracked files to appear in the dirty-check regardless of their pattern.
  • Output descriptions did not align with actual set/unset behavior, which is important for consumers using if: steps.X.outputs.Y == 'true' conditionals in their workflows.
  • Inconsistent presence of required: false made the schema look unintentional to contributors reading the file.

Impact

  • Users: No behavior change. These are documentation-only edits.
  • Backward compatibility: Fully preserved. No input names, defaults, or output names were changed.
  • Tooling: Marketplace and schema validators that read required: fields will now see consistent declarations across all inputs.

Testing

action.yml is not executable; correctness was validated by cross-referencing every changed field against entrypoint.sh:

  • file_pattern usage confirmed in both _git_is_dirty() and _add_files().
  • required: false is the implicit default in GitHub Actions; adding it explicitly changes no runtime behavior.
  • Output set/unset paths traced through _main(), _local_commit(), and the create_git_tag_only branch.

Copilot AI review requested due to automatic review settings May 7, 2026 08:14
Copy link
Copy Markdown
Contributor

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 input/output descriptions to better match the action’s actual runtime behavior and to make the action metadata schema more consistent for users and tooling.

Changes:

  • Clarifies file_pattern applies to both git add and the dirty-check, and supports multiple space-separated patterns.
  • Adds explicit required: false to inputs that were missing it (disable_globbing, create_branch, internal_git_binary).
  • Refines output descriptions (changes_detected, commit_hash, create_git_tag_only) to better document set/unset behavior and edge cases.

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

Comment thread action.yml Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@stefanzweifel stefanzweifel merged commit 32e9844 into stefanzweifel:master May 7, 2026
1 of 2 checks passed
@kranthipoturaju kranthipoturaju deleted the docs/fix-action-yml-descriptions branch May 8, 2026 08:04
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.

3 participants