Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct error in readme; adjust links to docs #9

Merged
merged 1 commit into from
Aug 4, 2023
Merged

Correct error in readme; adjust links to docs #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
[![.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)

**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.

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.

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

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.
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.

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.

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

## Use the Soda GitHub Action

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

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