Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,5 @@ Once you have your Personal Access Token:

## Related Documentation

- [Cloud-based Git Platform Integration](../2-getting-started/start-free-with-cloud.md#git-integration)
- [CI/CD Automation](../2-getting-started/start-free-with-cloud.md#cicd-automation)
- [Cloud-based Git Platform Integration](./start-free-with-cloud.md#git-integration)
- [CI/CD Getting Started](../7-cicd/ci-cd-getting-started.md)
6 changes: 3 additions & 3 deletions docs/2-getting-started/start-free-with-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Connect your repository to track pull requests/merge requests and validate chang

| GitHub | GitLab |
|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1. Navigate to settings<br>2. Connect GitHub repository<br>3. Authorize Recce access<br>4. Select repository | 1. Navigate to settings<br>2. Connect GitLab by providing a Personal Access Token ([see our directions here](../7-cicd/gitlab-pat-guide.md))<br>3. Connect a project by adding a GitLab Project or URL to a Recce Project |
| 1. Navigate to settings<br>2. Connect GitHub repository<br>3. Authorize Recce access<br>4. Select repository | 1. Navigate to settings<br>2. Connect GitLab by providing a Personal Access Token ([see our directions here](./gitlab-pat-guide.md))<br>3. Connect a project by adding a GitLab Project or URL to a Recce Project |


### How to Use PR/MR Tracking
Expand Down Expand Up @@ -109,8 +109,8 @@ See the CI/CD sections for complete setup guides:
- [Setup CI for GitHub](../7-cicd/github/setup-ci.md)
- [Setup CD for GitHub](../7-cicd/github/setup-cd.md)
- GitLab CI/CD
- [Setup CI for Gitlab](../7-cicd/gitlab/setup-ci.md)
- [Setup CD for Gitlab](../7-cicd/gitlab/setup-cd.md)
- [Setup CI for GitLab](../7-cicd/gitlab/setup-ci.md)
- [Setup CD for GitLab](../7-cicd/gitlab/setup-cd.md)

### Automation Benefits

Expand Down
42 changes: 26 additions & 16 deletions docs/7-cicd/ci-cd-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,33 +49,43 @@ Both CI and CD workflows follow the same pattern:

## Getting Started with your CI/CD

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).
Recce integrates with both GitHub Actions and GitLab CI/CD using the lightweight `recce-cloud` CLI. If you use another CI/CD platform and are interested in Recce, [let us know](https://cal.com/team/recce/chat).

## Prerequisites

Before setting up, ensure you have:

- **Recce Cloud account** You can signup and start your free trial [here](https://cloud.reccehq.com/)
- **Repository connected** to Recce Cloud ([setup guide](../2-getting-started/start-free-with-cloud.md#git-integration))
- **dbt artifacts generated** (`manifest.json` and `catalog.json`) from your project
- ✅ **Recce Cloud account** - [Start free trial](https://cloud.reccehq.com/)
- ✅ **Repository connected** to Recce Cloud - [Git integration guide](../2-getting-started/start-free-with-cloud.md#git-integration)
- For GitLab: [Create a Personal Access Token](../2-getting-started/gitlab-pat-guide.md) if not already done
- ✅ **dbt artifacts** - Know how to generate `manifest.json` and `catalog.json` from your project

### GitHub
If your dbt project uses GitHub:
## Setup Steps

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

### GitLab
If your dbt project uses GitLab:
### 1. Setup CD - Auto-update baseline
[**Setup CD Guide**](./setup-cd.md) - Configure automatic baseline updates when you merge to main

1. [Setup CD](./gitlab/setup-cd.md) - Auto-update baseline on merge to main
2. [Setup CI](./gitlab/setup-ci.md) - Auto-validate changes in every MR
3. [GitLab Personal Access Token Guide](./gitlab/gitlab-pat-guide.md) - Required for GitLab integration
- Updates your production baseline artifacts automatically
- Runs on merge to main + optional scheduled updates
- Works with both GitHub Actions and GitLab CI/CD

## Next steps
### 2. Setup CI - Auto-validate PRs/MRs
[**Setup CI Guide**](./setup-ci.md) - Enable automatic validation for every PR/MR

1. Start with relevant CD setup ([Gitlab](./gitlab/setup-cd.md) or [Github](./github/setup-cd.md)) to establish automatic baseline (production artifacts) updates.
2. Configure CI setup ([Gitlab](./gitlab/setup-ci.md) or [Github](./github/setup-ci.md)) to enable PR/MR validation
- Validates data changes in every pull request or merge request
- Catches issues before they reach production
- Works with both GitHub Actions and GitLab CI/CD

## Why This Order?

Start with **CD first** to establish your baseline (production artifacts), then add **CI** for PR/MR validation. CI validation compares your PR/MR changes against the baseline created by CD.

## Next Steps

1. **[Setup CD](./setup-cd.md)** - Establish automatic baseline updates
2. **[Setup CI](./setup-ci.md)** - Enable PR/MR validation
3. Review [best practices](./best-practices-prep-env.md) for environment preparation

## Related workflows
Expand Down
211 changes: 0 additions & 211 deletions docs/7-cicd/github/scenario-ci.md

This file was deleted.

Loading