Skip to content

Commit 9b5e5ee

Browse files
Add step id explanation for output in README.md (#324)
1 parent e040c59 commit 9b5e5ee

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Diff for: README.md

+7
Original file line numberDiff line numberDiff line change
@@ -167,9 +167,16 @@ You can use these outputs to trigger other Actions in your Workflow run based on
167167
- `changes_detected`: Returns either "true" or "false" if the repository was dirty and files have changed.
168168
- `commit_hash`: Returns the full hash of the commit if one was created.
169169

170+
**⚠️ When using outputs, the step needs to be given an id. See example below.**
171+
170172
### Example
171173

172174
```yaml
175+
- uses: stefanzweifel/git-auto-commit-action@v5
176+
id: auto-commit-action #mandatory for the output to show up in ${{ steps }}
177+
with:
178+
commit_message: Apply php-cs-fixer changes
179+
173180
- name: "Run if changes have been detected"
174181
if: steps.auto-commit-action.outputs.changes_detected == 'true'
175182
run: echo "Changes!"

0 commit comments

Comments
 (0)