docs(action): fix input and output descriptions in action.yml#406
Merged
stefanzweifel merged 2 commits intoMay 7, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
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_patternapplies to bothgit addand the dirty-check, and supports multiple space-separated patterns. - Adds explicit
required: falseto 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes several inaccuracies and omissions in
action.ymlinput and output descriptions to better reflect actual runtime behavior.Changes
file_pattern: Description now states the pattern is applied to bothgit addand thegit statusdirty-check, and that multiple space-separated patterns are supported.required: false: Added todisable_globbing,create_branch, andinternal_git_binary, which were the only inputs missing this field.changes_detectedoutput: Rewritten to cover the CRLF-only edge case (wheregit diff --stagedyields no diff after staging, resetting the value to"false") and to note the output is absent increate_git_tag_onlymode.commit_hashoutput: Clarified that it is only set when a commit is actually created, not merely when changes are detected.create_git_tag_onlyoutput: 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_patternimplied it only affectedgit add, leading users to expect untracked files to appear in the dirty-check regardless of their pattern.if: steps.X.outputs.Y == 'true'conditionals in their workflows.required: falsemade the schema look unintentional to contributors reading the file.Impact
required:fields will now see consistent declarations across all inputs.Testing
action.ymlis not executable; correctness was validated by cross-referencing every changed field againstentrypoint.sh:file_patternusage confirmed in both_git_is_dirty()and_add_files().required: falseis the implicit default in GitHub Actions; adding it explicitly changes no runtime behavior._main(),_local_commit(), and thecreate_git_tag_onlybranch.