Skip to content

Commit 32e9844

Browse files
kranthipoturajuKranthi PoturajustefanzweifelCopilot
authored
docs(action): fix input and output descriptions in action.yml (#406)
* docs(action): fix input and output descriptions in action.yml * Update Wording Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Kranthi Poturaju <Kranthi.Poturaju1@aexp.com> Co-authored-by: Stefan Zweifel <stefanzweifel@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent a3ed46f commit 32e9844

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

action.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ inputs:
2525
required: false
2626
default: ''
2727
file_pattern:
28-
description: File pattern used for `git add`. For example `src/*.js`
28+
description: File pattern used for `git add` and the dirty-check (`git status`). Supports multiple space-separated patterns. For example `src/*.js`
2929
required: false
3030
default: '.'
3131
repository:
@@ -74,26 +74,29 @@ inputs:
7474
default: false
7575
disable_globbing:
7676
description: Stop the shell from expanding filenames (https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html)
77+
required: false
7778
default: false
7879
create_branch:
7980
description: Create new branch with the name of `branch`-input in local and remote repository, if it doesn't exist yet.
81+
required: false
8082
default: false
8183
create_git_tag_only:
8284
description: Perform a clean git tag and push, without commiting anything
8385
required: false
8486
default: false
8587
internal_git_binary:
8688
description: Internal use only! Path to git binary used to check if git is available. (Don't change this!)
89+
required: false
8790
default: git
8891

8992

9093
outputs:
9194
changes_detected:
92-
description: Value is "true", if the repository was dirty and file changes have been detected. Value is "false", if no changes have been detected.
95+
description: Value is "true" if matching changes were detected and committed. Value is "false" if no matching changes were detected or only CRLF changes were staged. Not set in `create_git_tag_only` mode.
9396
commit_hash:
94-
description: Full hash of the created commit. Only present if the "changes_detected" output is "true".
97+
description: Full hash of the created commit. Only set when a commit was actually made (i.e. `changes_detected` is "true").
9598
create_git_tag_only:
96-
description: Value is "true", if a git tag was created using the `create_git_tag_only`-input.
99+
description: Set to "true" when the action ran in `create_git_tag_only` mode. Never set to "false".
97100

98101
runs:
99102
using: 'node24'

0 commit comments

Comments
 (0)