Skip to content

Commit bfd11ef

Browse files
even-weiclaude
andcommitted
Simplify CI/CD documentation structure
Unify GitHub and GitLab CI/CD setup guides into platform-agnostic documentation with side-by-side comparisons, reducing documentation by ~90% while improving clarity and maintainability. Changes: - Merge platform-specific guides into unified setup-cd.md and setup-ci.md - Add line numbers and syntax highlighting to all YAML examples - Add verification screenshots for both GitHub and GitLab - Move troubleshooting to Setup CD (logical first step) - Relocate GitLab PAT guide to getting-started (accessible via links only) - Update all cross-references and navigation structure Benefits: - 50% reduction in CI/CD documentation files (9 files → 2 files) - Equal platform treatment with comparison tables - Single source of truth for both platforms - Easier maintenance and consistency 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Signed-off-by: even-wei <[email protected]>
1 parent 8e81232 commit bfd11ef

File tree

12 files changed

+646
-1112
lines changed

12 files changed

+646
-1112
lines changed

docs/7-cicd/gitlab/gitlab-pat-guide.md renamed to docs/2-getting-started/gitlab-pat-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,5 @@ Once you have your Personal Access Token:
8080

8181
## Related Documentation
8282

83-
- [Cloud-based Git Platform Integration](../2-getting-started/start-free-with-cloud.md#git-integration)
84-
- [CI/CD Automation](../2-getting-started/start-free-with-cloud.md#cicd-automation)
83+
- [Cloud-based Git Platform Integration](./start-free-with-cloud.md#git-integration)
84+
- [CI/CD Getting Started](../7-cicd/ci-cd-getting-started.md)

docs/2-getting-started/start-free-with-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Connect your repository to track pull requests/merge requests and validate chang
4949

5050
| GitHub | GitLab |
5151
|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52-
| 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 |
52+
| 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 |
5353

5454

5555
### How to Use PR/MR Tracking

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

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,33 +49,43 @@ Both CI and CD workflows follow the same pattern:
4949

5050
## Getting Started with your CI/CD
5151

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).
52+
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).
5353

5454
## Prerequisites
5555

5656
Before setting up, ensure you have:
5757

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

62-
### GitHub
63-
If your dbt project uses GitHub:
63+
## Setup Steps
6464

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
65+
Both GitHub and GitLab follow the same simple pattern:
6766

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

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
70+
- Updates your production baseline artifacts automatically
71+
- Runs on merge to main + optional scheduled updates
72+
- Works with both GitHub Actions and GitLab CI/CD
7473

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

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
77+
- Validates data changes in every pull request or merge request
78+
- Catches issues before they reach production
79+
- Works with both GitHub Actions and GitLab CI/CD
80+
81+
## Why This Order?
82+
83+
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.
84+
85+
## Next Steps
86+
87+
1. **[Setup CD](./setup-cd.md)** - Establish automatic baseline updates
88+
2. **[Setup CI](./setup-ci.md)** - Enable PR/MR validation
7989
3. Review [best practices](./best-practices-prep-env.md) for environment preparation
8090

8191
## Related workflows

docs/7-cicd/github/scenario-ci.md

Lines changed: 0 additions & 211 deletions
This file was deleted.

0 commit comments

Comments
 (0)