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

Commit cc2ba5d

Browse files
authored
Merge pull request #9 from sodadata/change/correct-readme-typo
Correct error in readme; adjust links to docs
2 parents 670ffd3 + 0dc3c98 commit cc2ba5d

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
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

55
**Soda** enables Data Engineers to test data for quality where and when they need to. It works by taking the data quality checks that you prepare and using them to run a scan of datasets in a data source.
6+
67
A scan is a CLI command which instructs Soda to prepare optimized SQL queries that execute data quality checks on your data source to find invalid, missing, or unexpected data. When checks fail, they surface bad-quality data and present check results that help you investigate and address quality issues.
78

89
Add the **GitHub Action for Soda** to your GitHub Workflow to automatically execute scans for data quality during development.
910

10-
In a repository in which are adding a transformation or making changes to a dbt model, for example, you can add the Soda GitHub Action to your workflow so that with each new PR, or commit to an existing PR, it executes a Soda scan for data quality and presents the results of the scan in a comment in the pull request, and in a report in Soda Cloud.
11+
For example, in a repository in which you are adding a transformation or making changes to a dbt model, you can add the Soda GitHub Action to your workflow. With each new PR, or commit to an existing PR, it executes a Soda scan for data quality and presents the results of the scan in a comment in the pull request, and in a report in Soda Cloud.
1112

1213
Where the scan results indicate an issue with data quality, Soda notifies you both in the PR comment, and by email so that you can investigate and address any issues before merging the PR into production.
1314

14-
Refer to [Soda documentation](https://docs.soda.io/soda/quick-start-dev.html) for an example use case.
15+
Refer to [Soda documentation](https://go.soda.io/soda-action) for an example use case.
1516

1617
## Use the Soda GitHub Action
1718

@@ -59,4 +60,4 @@ Refer to [testing files](https://github.com/sodadata/soda-github-action/tree/mai
5960
- Windows runners are not supported, including the use of official Windows-based images such as `windows-latest`.
6061
- MacOS runners require installation of Docker because `macos-latest` does not come with Docker pre-installed.
6162

62-
Access [Soda documentation](https://go.soda.io/docs) for more information.
63+
Access [Soda documentation](https://go.soda.io/soda-action) for more information.

0 commit comments

Comments
 (0)