Skip to content

Commit

Permalink
Removed info about permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
janet-can committed Jul 27, 2023
1 parent fb91724 commit eb7e083
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ jobs:
data_source: snowflake
configuration: ./configuration.yaml
checks: ./checks.yaml
permissions:
pull-requests: write
```
Refer to [testing files](https://github.com/sodadata/soda-github-action/tree/main/testing) and the [test workflow](https://github.com/sodadata/soda-github-action/blob/main/.github/workflows/tests.yaml) for more context for the example.
Expand All @@ -60,16 +58,6 @@ Refer to [testing files](https://github.com/sodadata/soda-github-action/tree/mai
| `checks` | File path to checks YAML file. See [Soda docs](https://go.soda.io/configure). Compatible with shell filename extensions.<br /> Identify multiple check files, if you wish. For example: `./checks_*.yaml` or `./{check1.yaml,check2.yaml}` | ✅ | - |


### Permissions
The GitHub Action only creates comments for workflows run by a `pull_request` event.

Because the Soda GitHub Action posts a comment to the PR with scan results, you must specify the workflow step's permission when using the action in a `pull_request` event.
```yaml
permissions:
pull-requests: write
```


### Self-hosted runners

- Windows runners are not supported, including the use of official Windows-based images such as `windows-latest`.
Expand Down

0 comments on commit eb7e083

Please sign in to comment.