Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
marcransome committed May 23, 2021
2 parents 476660f + 2e81113 commit f95dabe
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A GitHub action for syntax checking [fish shell](https://fishshell.com) files.

<img src="example.png" width="800">
<img src="example.png">

## Prerequisites

Expand All @@ -20,7 +20,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Syntax check
uses: fish-shop/[email protected].0
uses: fish-shop/[email protected].1
```
By default, all files under `$GITHUB_WORKSPACE` with a `.fish` file extension are checked. To specify a different file pattern to match against provide a value for the `pattern` input. For example, to check all `.fish` files in the `src` directory of your repository:
Expand All @@ -29,11 +29,23 @@ By default, all files under `$GITHUB_WORKSPACE` with a `.fish` file extension ar
...
steps:
- name: Syntax check
uses: fish-shop/[email protected].0
uses: fish-shop/[email protected].1
with:
pattern: src/**.fish
```

Multiple `pattern` values are also supported:

```yaml
...
steps:
- name: Syntax check
uses: fish-shop/[email protected]
with:
pattern: conf.d/**.fish functions/pond.fish completions/**.fish
```


## Acknowledgements

* This project was inspired by [fish-actions/syntax-check](https://github.com/fish-actions/syntax-check).
Expand Down

0 comments on commit f95dabe

Please sign in to comment.