Skip to content

Commit 9be9bf1

Browse files
committed
updating file with edits
1 parent 64bf960 commit 9be9bf1

File tree

1 file changed

+37
-41
lines changed

1 file changed

+37
-41
lines changed

docs/7-cicd/ci-cd-getting-started.md

Lines changed: 37 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,82 +10,78 @@ Automate data validation in your development workflow. Catch data issues before
1010

1111
Set up automated workflows that:
1212

13-
- **Maintain current baselines** - Auto-update comparison baselines on every merge to main
14-
- **Validate every PR/MR** - Run data validation checks automatically when changes are proposed
13+
- **Save time on reviews** - Eliminate manual validation steps for every change
14+
- **Run data validations on every pull request/merge request** - Run data validation checks automatically when changes are proposed
1515
- **Prevent regressions** - Catch data quality issues before they reach production
16-
- **Save team time** - Eliminate manual validation steps for every change
1716

1817
!!!note
19-
CI/CD automation requires Recce Cloud Team plan. A free trial is available.
18+
CI/CD automation requires a Cloud Plan. Get started for free [here](https://cloud.reccehq.com/).
2019

21-
## Understanding CI vs CD
20+
## What is CI/CD?
2221

23-
Recce uses both continuous integration and continuous delivery to automate data validation:
22+
Recce uses both continuous integration (CI) and continuous delivery (CD) to automate data validation:
2423

2524
**Continuous Integration (CI)**
2625

27-
- **When**: Runs on every PR/MR update
28-
- **Purpose**: Validates proposed changes against baseline
26+
- **When**: Runs when you open a new or update a Pull Request/Merge Request
27+
- **Purpose**: Validates proposed changes against baseline (typically this mean production)
2928
- **Benefit**: Catches issues before merge, with results in your PR/MR
3029

3130
**Continuous Delivery (CD)**
3231

3332
- **When**: Runs after merge to main branch
34-
- **Purpose**: Updates your baseline Recce session with latest production state
33+
- **Purpose**: Updates baseline artifacts Recce uses to with latest production state
3534
- **Benefit**: Ensures future comparisons use current baseline
3635

37-
## Choose your platform
36+
## What does look like with Recce?
3837

39-
Recce integrates with both GitHub Actions and GitLab CI/CD.
40-
41-
Select your Git platform to get started:
38+
Both CI and CD workflows follow the same pattern:
4239

43-
### GitHub
44-
If your dbt project uses GitHub:
40+
1. **Trigger event** (merge to main, or PR/MR opened/updated)
41+
2. **Generate dbt artifacts** (`dbt docs generate` or external source)
42+
3. **Upload to Recce Cloud** (automatic via workflow action)
43+
4. **Validation results** appear in Recce dashboard and PR/MR
4544

46-
1. [Setup CI](./github/setup-ci.md) - Auto-validate changes in every PR
47-
2. [Setup CD](./github/setup-cd.md) - Auto-update baseline on merge to main
45+
<figure markdown>
46+
![Recce CI/CD architecture](../assets/images/7-cicd/ci-cd.png){: .shadow}
47+
<figcaption>Automated validation workflow for pull requests</figcaption>
48+
</figure>
4849

49-
### GitLab
50-
If your dbt project uses GitLab:
50+
## Getting Started with your CI/CD
5151

52-
2. [Setup CI](./gitlab/setup-ci.md) - Auto-validate changes in every MR
53-
1. [Setup CD](./gitlab/setup-cd.md) - Auto-update baseline on merge to main
54-
3. [GitLab Personal Access Token Guide](./gitlab/gitlab-pat-guide.md) - Required for GitLab integration
52+
Recce currently integrates with both GitHub Actions and GitLab CI/CD. If you use another CI/CD product and interested in Recce, [let us know](https://cal.com/team/recce/chat).
5553

5654
## Prerequisites
5755

5856
Before setting up, ensure you have:
5957

60-
- **Recce Cloud account** with Team plan or free trial
58+
- **Recce Cloud account** You can signup and start your free trial [here](https://cloud.reccehq.com/)
6159
- **Repository connected** to Recce Cloud ([setup guide](../2-getting-started/start-free-with-cloud.md#git-integration))
62-
- **dbt artifacts** (`manifest.json` and `catalog.json`) from your project
60+
- **dbt artifacts generated** (`manifest.json` and `catalog.json`) from your project
6361

64-
## Architecture overview
62+
### GitHub
63+
If your dbt project uses GitHub:
6564

66-
Both CI and CD workflows follow the same pattern:
65+
1. [Setup CD](./github/setup-cd.md) - Auto-update baseline on merge to main
66+
2. [Setup CI](./github/setup-ci.md) - Auto-validate changes in every PR
6767

68-
1. **Trigger event** (merge to main, or PR/MR opened/updated)
69-
2. **Generate dbt artifacts** (`dbt docs generate` or external source)
70-
3. **Upload to Recce Cloud** (automatic via workflow action)
71-
4. **Validation results** appear in Recce dashboard and PR/MR
68+
### GitLab
69+
If your dbt project uses GitLab:
7270

73-
<figure markdown>
74-
![Recce CI/CD architecture](../assets/images/7-cicd/ci-cd.png){: .shadow}
75-
<figcaption>Automated validation workflow for pull requests</figcaption>
76-
</figure>
71+
1. [Setup CD](./gitlab/setup-cd.md) - Auto-update baseline on merge to main
72+
2. [Setup CI](./gitlab/setup-ci.md) - Auto-validate changes in every MR
73+
3. [GitLab Personal Access Token Guide](./gitlab/gitlab-pat-guide.md) - Required for GitLab integration
7774

7875
## Next steps
7976

80-
1. Choose your platform (GitHub or GitLab)
81-
2. Start with CD setup to establish baseline updates
82-
3. Add CI setup to enable PR/MR validation
83-
4. Review [best practices](./best-practices-prep-env.md) for environment preparation
77+
1. Start with relevant CD setup ([Gitlab](./gitlab/setup-cd.md) or [Github](./github/setup-cd.md)) to establish automatic baseline (production artifacts) updates.
78+
2. Configure CI setup ([Gitlab](./gitlab/setup-ci.md) or [Github](./github/setup-ci.md)) to enable PR/MR validation
79+
3. Review [best practices](./best-practices-prep-env.md) for environment preparation
8480

8581
## Related workflows
8682

8783
After setting up CI/CD automation, explore these workflow guides:
8884

89-
- [Development workflow](./scenario-dev.md) - Validate changes during development
90-
- [PR/MR review workflow](./scenario-pr-review.md) - Collaborate on validation results
91-
- [Preset checks](./preset-checks.md) - Configure automatic validation checks
85+
- [Development workflow](./scenario-dev.md) - How to validate data impact during development (pre-PR/MR)
86+
- [PR/MR review workflow](./scenario-pr-review.md) - How to collaborate with teammates using Recce in PRs/MRs
87+
- [Preset checks](./preset-checks.md) - How to configure automatic validation checks

0 commit comments

Comments
 (0)