Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add files_renamed documentation #136

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ steps.file_changes.outputs.files_modified - `string` - The names of the updated

steps.file_changes.outputs.files_removed - `string` - The names of the removed files. The output is dependant on the output input, default is a json string.

### files_renamed

steps.file_changes.outputs.files_renamed - `string` - The names of the renamed files. The output is dependant on the output input, default is a json string.

## Example usage

```yaml
Expand Down Expand Up @@ -142,10 +146,12 @@ jobs:
cat $HOME/files_modified.json
cat $HOME/files_added.json
cat $HOME/files_removed.json
cat $HOME/files_renamed.json
echo '${{ steps.file_changes.outputs.files}}'
echo '${{ steps.file_changes.outputs.files_modified}}'
echo '${{ steps.file_changes.outputs.files_added}}'
echo '${{ steps.file_changes.outputs.files_removed}}'
echo '${{ steps.file_changes.outputs.files_renamed}}'
```

You can set the output and fileOutput to ',' for csv output.
Expand Down