Skip to content
This repository was archived by the owner on Jan 29, 2026. It is now read-only.

Commit bf4ff93

Browse files
committed
update readme
1 parent 33fd799 commit bf4ff93

1 file changed

Lines changed: 2 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
[![GitHub Super-Linter](https://github.com/sodadata/soda-github-action/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)
33
[![.github/workflows/tests.yaml](https://github.com/sodadata/soda-github-action/actions/workflows/tests.yaml/badge.svg)](https://github.com/sodadata/soda-github-action/actions/workflows/tests.yaml)
44

5+
Prevent downstream data quality issues by integrating the Soda Library into your CI/CD pipeline.
6+
57
## Example usage
68

79
```yaml
@@ -29,16 +31,6 @@ Also refer to [testing files](https://github.com/sodadata/soda-github-action/tre
2931
| `configuration` | Configuration file path. See [docs](https://docs.soda.io/soda-core/configuration.html) | ✅ | - |
3032
| `checks` | Checks file path. See [docs](https://docs.soda.io/soda-core/scan-core.html#anatomy-of-a-scan-command). Allows for using shell filename extensions. You can match multiple check files, for example: `checks: ./checks_*.yaml` or `checks: ./{check1.yaml,check2.yaml}` | ✅ | - |
3133

32-
33-
### Permissions
34-
When using the action in `pull_request` event, it is required to specify step's permissions as follows:
35-
```yaml
36-
permissions:
37-
pull-requests: write
38-
```
39-
as the action posts a comment with the scan results to the PR.
40-
Note the comment is only created for workflows run by `pull_request` event.
41-
4234
### Self-hosted runners caveats
4335
When running this action on self-hosted runners, there are some additional caveats:
4436

0 commit comments

Comments
 (0)