Skip to content

Commit

Permalink
fix the README
Browse files Browse the repository at this point in the history
  • Loading branch information
rnsc committed Jul 13, 2021
1 parent efa0e8c commit b05c075
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ See [action.yml](action.yml)
# Can be 'space-delimited', 'csv', or 'json'.
# Default: 'space-delimited'
format: ''
# Filter files using a regex
# Filter files using a glob filter
filter: '*'
```
Expand All @@ -34,6 +34,7 @@ See [action.yml](action.yml)
- [Usage](#usage)
- [Scenarios](#scenarios)
- [Get all changed files as space-delimited](#get-all-changed-files-as-space-delimited)
- [Get all changed *.php files as space-delimited](#get-all-changed-php-files-as-space-delimited)
- [Get all changed *.yml files but exclude .github/*/*.yml files](#get-all-changed-yml-files-but-exclude-githubyml-files)
- [Get all added and modified files as CSV](#get-all-added-and-modified-files-as-csv)
- [Get all removed files as JSON](#get-all-removed-files-as-json)
Expand All @@ -45,6 +46,20 @@ See [action.yml](action.yml)
If there are any files with spaces in them, then this method won't work and the step will fail.
Consider using one of the other formats if that's the case.
```yaml
- id: files
uses: Ana06/get-changed-files@v2.0.0
- run: |
for changed_file in ${{ steps.files.outputs.all }}; do
echo "Do something with this ${changed_file}."
done
```
### Get all changed *.php files as space-delimited
If there are any files with spaces in them, then this method won't work and the step will fail.
Consider using one of the other formats if that's the case.
```yaml
- id: files
uses: Ana06/get-changed-files@v2.0.0
Expand All @@ -65,11 +80,6 @@ If those two globs were inverted, you **would** include all the YML files, with
```yaml
- uses: Ana06/get-changed-files@v2.0.0
with:
# Format of the steps output context.
# Can be 'space-delimited', 'csv', or 'json'.
# Default: 'space-delimited'
format: ''
# Filter files using a regex
filter: |
*.yml
!.github/*/*.yml
Expand Down

0 comments on commit b05c075

Please sign in to comment.