Skip to content

Commit f8b7bb6

Browse files
d-bytebaseclaude
andauthored
docs: enhance SQL Review CI documentation (#883)
- Add setup prerequisites section with links to SQL Review Policy and GitOps Installation - Include example configuration links for all supported platforms (GitHub, GitLab, Bitbucket, Azure DevOps) - Clarify that users should adjust examples to match their workflow - Improve page structure and clarity 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <[email protected]>
1 parent 7c3ff9b commit f8b7bb6

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

mintlify/gitops/sql-review-ci.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,41 @@
22
title: SQL Review CI
33
---
44

5-
Once you've set up the [GitOps Workflow](/gitops/overview/), your SQL Review Policy will automatically be applied to all pull/merge requests. The results of the SQL review will appear as a comment.
5+
SQL Review CI validates your SQL changes against configured policies during pull/merge requests. The review bot posts feedback directly as PR comments.
6+
7+
## Setup
8+
9+
Before enabling SQL Review CI:
10+
11+
1. [Set up SQL Review Policy](/sql-review/review-policy) - Define your SQL standards and rules
12+
2. [Install GitOps Integration](/gitops/installation) - Connect Bytebase to your VCS
13+
14+
## Examples
15+
16+
We provide examples for GitHub, GitLab, Bitbucket, and Azure DevOps below. Adjust the parameters to match your repository structure and workflow.
617

718
## GitHub
819

920
<Card title="Tutorial: SQL Review with GitHub Actions" icon="graduation-cap" href="/tutorials/gitops-github-workflow#step-3-configure-sql-review-in-bytebase" horizontal />
1021

22+
<Card title="Example: GitHub Actions Workflow" icon="code" href="https://github.com/bytebase/example-gitops-github-flow/blob/main/.github/workflows/sql-review-action.yml" horizontal />
23+
1124
![github](/content/docs/gitops/sql-review-ci/github-pr-sql-review.webp)
1225

1326
## GitLab
1427

28+
<Card title="Example: GitLab CI Configuration" icon="code" href="https://gitlab.com/bytebase-sample/gitops-example/-/blob/main/bytebase-review.yml" horizontal />
29+
1530
![gitlab](/content/docs/gitops/sql-review-ci/gitlab-pr-sql-review.webp)
1631

1732
## Bitbucket
1833

34+
<Card title="Example: Bitbucket Pipelines" icon="code" href="https://bitbucket.org/p0nyyy/cicd/src/main/bitbucket-pipelines.yml" horizontal />
35+
1936
![bitbucket](/content/docs/gitops/sql-review-ci/bb-pr-sql-review.webp)
2037

2138
## Azure DevOps
2239

23-
![azure devops](/content/docs/gitops/sql-review-ci/azure-devops-pr-sql-review.webp)
40+
<Card title="Example: Azure Pipelines" icon="code" href="https://dev.azure.com/bytebase-hq/_git/bytebase-example?path=/pipelines/sql-review.yml" horizontal />
41+
42+
![azure devops](/content/docs/gitops/sql-review-ci/azure-devops-pr-sql-review.webp)

0 commit comments

Comments
 (0)