Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
platinummonkey committed Aug 2, 2023
1 parent 74d9cc6 commit a6454b6
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,31 @@ It would be expected to use this action for other downstream conditional steps t
**Optional** A newline separated list of regex paths to ignore.
**Default** ``
**Example**
```
foo/.*\.json
bar/.*\.ini
```

### `only_file_patterns`

**Optional** A newline separated list of regex paths to only consider. This is applied before `ignore_file_patterns`.
**Default** ``
**Example**
```
foo/.*\.json
bar/.*\.ini
```

### `filter_by_status`

**Optional** A newline separated list of status to filter by, options are: `added,removed,modified,renamed,copied,changed,unchanged`. This is applied before `ignore_file_patterns`.
**Default** `` - meaning all.
**Example**
```
added
copied
renamed
```

## Outputs

Expand Down Expand Up @@ -119,6 +125,14 @@ jobs:
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
separator: ','
ignore_files_pattern: |
foo/.*\.json
only_files_pattern: |
foo/bar.*
filter_by_status: |
added
modified
deleted
- name: output results
shell: bash
env:
Expand Down

0 comments on commit a6454b6

Please sign in to comment.