You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Launch Recce in under 2 minutes** to validate your data changes. We offer two paths to getting started.
7
+
**Launch Recce in under 2 minutes**. Each following feature provides additional value. The progressive features help you get more value from Recce over time.
Recce shows what changed between **base** and **current** environments and helps assess potential impact. The most common case is comparing your development branch against your production or main branch to see what your changes will impact.
14
14
15
-
-**Best if**: You want to try without GitHub permissions
16
-
-**You get**: Launch Recce with your actual dbt project
17
-
-**Setup**: Upload your development and production artifacts locally
18
-
-**Immediate value**: See your real project lineage and metadata diffs
19
-
- ✨ **You'll know it's working when**: Your models appear in the lineage graph
15
+
You can:
20
16
21
-
<br>
22
-
If you don't have a dbt project, you can just click "Launch" to see the Jaffle Shop sample project loaded.
17
+
- Explore with the pre-loaded Jaffle Shop data
18
+
- Upload your metadata (see below)
19
+
-**Skip manual upload go directly to [CI/CD automation](#cicd-automation)**
23
20
24
-
### Connect to view all your PR
21
+
<!-- insert a video -->
25
22
26
-
-**Best if**: You have a current PR and GitHub permissions
27
-
-**You get**: List all your PRs and validate any of them
28
-
-**Setup**: Connect GitHub (installs Recce app) and upload your PR snapshots
29
-
-**Immediate value**: See all PRs and do validation
30
-
- ✨ **You'll know it's working when**: Your PRs appear in a the project
23
+
### Upload Metadata
24
+
- Web interface: Click "Update" on the session you want to update in Recce Cloud.
25
+
1. Click "Update" in base session to upload baseline metadata
26
+
2. Click "Update" in current session to upload comparison metadata
Download the artifacts directly from dbt docs server:
60
56
61
-
-**What you'll unlock**: Automatic validation on every PR
62
-
-**Setup needed**: [Set up automated workflows](../7-cicd/scenario-ci.md)
63
-
-**Ultimate value**:
64
-
- ✅ **Automatic PR checks** - validation runs on every push
65
-
- ✅ **Team workflows** - standardized validation across team
66
-
- ✅ **PR blocking** - prevent bad changes from merging
57
+
-`<dbt_docs_url>/manifest.json`
58
+
-`<dbt_docs_url>/catalog.json`
59
+
60
+
#### Current Metadata
61
+
62
+
Use development environment or PR branch as current to compare against the base.
63
+
64
+
Choose one method:
65
+
66
+
**Method 1: Generate locally**
67
+
68
+
```
69
+
dbt docs generate --target <your_dev_target>
70
+
```
71
+
72
+
**Method 2: dbt Cloud**<br>
73
+
Deploy → Jobs → CI job → Recent run → Download artifacts
74
+
75
+
76
+
## Data Warehouse Diffing {#data-diffing}
77
+
78
+
Go beyond metadata to see how changes affect your actual data. Configure your data warehouse connection to compare query results and catch issues before they impact production.
79
+
80
+
### Setup Requirements
81
+
82
+
- Data warehouse credentials with read access
83
+
- Network connectivity to your warehouse
84
+
- Base and current environments configured in previous step
85
+
86
+
### Supported Warehouses
87
+
88
+
- Snowflake
89
+
- others are on upcoming future
90
+
91
+
### Warehouse Connection
92
+
93
+
Configure connection to your data warehouse to enable query result comparisons.
94
+
95
+
**Connection setup:**
96
+
97
+
1. Navigate to [settings](https://cloud.reccehq.com/settings#organization){target="_blank"}
98
+
2. Add Connection
99
+
100
+
Your connection credentials are secure. See our [security practices](https://reccehq.com/security/){target="_blank"} for details.
101
+
102
+
<!-- insert a video -->
103
+
104
+
### How to Use Data Diffing
105
+
106
+
Recce supports several data diffing methods. See Data Diffing sections for details:
Connect your GitHub repo to see all PRs in one place and validate changes before they hit production.
118
+
119
+
### Setup Requirements
120
+
121
+
- GitHub repository with dbt project
122
+
- Repository admin access for initial setup
123
+
- Active PRs with model changes
124
+
125
+
!!!Note
126
+
You'll need administrative access to the GitHub organization you want to connect. Please ensure you have the necessary permissions for **GitHub App installations**.
127
+
128
+
### GitHub Connection
129
+
130
+
Connect your repository to track pull requests and validate changes.
131
+
132
+
**Connection setup:**
133
+
134
+
1. Navigate to settings
135
+
2. Connect GitHub repository
136
+
3. Authorize Recce access
137
+
4. Select repository
138
+
139
+
<!-- insert a video -->
140
+
141
+
### How to Use PR Tracking
142
+
143
+
Once connected, Recce displays all open and draft PRs in your dashboard.
144
+
145
+
### PR Validation Workflow
146
+
147
+
- View open/draft PRs in dashboard
148
+
- Select PR to validate
149
+
- Upload PR metadata (until CI/CD is configured)
150
+
- Launch Recce to analyze changes
151
+
152
+
153
+
## CI/CD Automation {#cicd-automation}
154
+
155
+
Set up CI/CD to automatically upload metadata and run validation checks on every PR.
0 commit comments