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 a6454b6 commit 50ae48e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,25 @@ It would be expected to use this action for other downstream conditional steps t
### `github-token`

**Required** The github token, for the most part you can just use `${{ secrets.GITHUB_TOKEN }}`.

**Example**
`${{ secrets.GITHUB_TOKEN }}`

### `separator`

**Required** The separator to use on output.

**Default** `,`

**Example**
`${{ secrets.GITHUB_TOKEN }}`

### `ignore_file_patterns`

**Optional** A newline separated list of regex paths to ignore.

**Default** ``

**Example**
```
foo/.*\.json
Expand All @@ -35,7 +40,9 @@ 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
Expand All @@ -45,7 +52,9 @@ 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
Expand Down

0 comments on commit 50ae48e

Please sign in to comment.