Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytebase/sql-review-action
The GitHub Action for SQL Review.
https://github.com/bytebase/sql-review-action
ci github-actions lint mysql postgres review sql style-guide
Last synced: 8 days ago
JSON representation
The GitHub Action for SQL Review.
- Host: GitHub
- URL: https://github.com/bytebase/sql-review-action
- Owner: bytebase
- License: mit
- Created: 2022-08-02T08:11:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-16T06:25:43.000Z (12 months ago)
- Last Synced: 2024-10-31T10:44:19.115Z (15 days ago)
- Topics: ci, github-actions, lint, mysql, postgres, review, sql, style-guide
- Language: Shell
- Homepage:
- Size: 213 KB
- Stars: 37
- Watchers: 6
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQL Review Action
The GitHub Action for SQL Review. Parse and check the SQL statement according to the [SQL review rules](https://www.bytebase.com/sql-review-guide) to detect SQL anti-patterns and enforce schema consistency across the organization.
## Usage
Create a file in `.github/workflows/sql-review.yml` in your repository and insert the following content:
```yml
on: [pull_request]
jobs:
sql-review:
runs-on: ubuntu-latest
name: SQL Review
steps:
- uses: actions/checkout@v3
- name: Check SQL
# You can change it to a specific version like bytebase/[email protected]
# We suggest using the latest version through the tag. Check it at https://github.com/Bytebase/sql-review-action/tags
uses: bytebase/sql-review-action@main
with:
override-file-path: ""
template-id: ""
database-type: ""
file-pattern: ""
```
The action will be triggered in any pull request which has SQL files changed. It will call the SQL review service to check if the change is valid according to the SQL review rules.
### About parameters
- `database-type`: **Required**. The database type, should be one of:
- `MYSQL`
- `POSTGRES`
- `TIDB`
- `ORACLE`
- `OCEANBASE_ORACLE`
- `OCEANBASE`
- `SNOWFLAKE`
- `MSSQL`
- `MARIADB`
- `override-file-path`: **Optional**. Your SQL review rules configuration file path. You can configure and generate this file in [Bytebase SQL Review Guide](https://www.bytebase.com/sql-review-guide) page. You can ignore this parameter and only provide the `template-id` if you don't want to customize rules.
- `template-id`: **Optional**. The SQL Review rule template id, should be one of [`bb.sql-review.prod`](https://bytebase.com//sql-review-guide?templateId=bb.sql-review.prod) or [`bb.sql-review.dev`](https://bytebase.com//sql-review-guide?templateId=bb.sql-review.dev). You can ignore this parameter if you provide the `override-file-path` parameter.
- `file-pattern`: **Optional**. The file path regex pattern for your SQL files. Defaults `^.*\.sql$`. For example, if you only want to subscribe to the SQL file changes in the `db` folder, you can set this parameter to `^db/.*\.sql$`.
## Examples
Once you configure the action, you can get these error or warning message based on your SQL review rules:
- [bytebase/sql-review-action-example](https://github.com/Bytebase/sql-review-action-example) shows a minimum example of configuring and overriding the SQL rules for multiple database systems.
- [bytebase/bytebase](https://github.com/Bytebase/Bytebase) shows an example of onboarding SQL Review action into a real world project.
- Check this PR [chore: add sql review action](https://github.com/Bytebase/Bytebase/pull/2100) to see how to add this action into your repository.
- Check this PR [chore: add test sql](https://github.com/Bytebase/Bytebase/pull/2177/files) to see how this action works in your pull request.