Skip to content

Commit 8e81232

Browse files
even-weiclaude
andcommitted
Add expected output examples for recce-cloud upload
Add real-world CLI output examples to help users verify their CI/CD setup is working correctly. Shows the detailed output from recce-cloud upload command including: - CI environment detection (platform, PR/MR number, branches, etc.) - Authentication method used (GITHUB_TOKEN/CI_JOB_TOKEN) - Session creation and artifact upload progress - Success confirmation with session ID and URLs Examples added to: - GitHub CI setup (PR validation) - GitHub CD setup (production baseline) - GitLab CI setup (MR validation) - GitLab CD setup (production baseline) These examples help users: - Confirm their setup is working correctly - Understand what information is automatically detected - Verify authentication is working - Get session IDs and URLs for reviewing changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Signed-off-by: even-wei <[email protected]>
1 parent e1a22b2 commit 8e81232

File tree

4 files changed

+96
-6
lines changed

4 files changed

+96
-6
lines changed

docs/7-cicd/github/setup-cd.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,28 @@ jobs:
105105

106106
![Recce Cloud showing updated base sessions](../../assets/images/7-cicd/verify-setup-github-cd.png){: .shadow}
107107

108+
#### Expected Output
109+
110+
When the upload succeeds, you'll see output like this in your workflow logs:
111+
112+
```
113+
─────────────────────────── CI Environment Detection ───────────────────────────
114+
Platform: github-actions
115+
Session Type: prod
116+
Commit SHA: def456ab...
117+
Source Branch: main
118+
Repository: your-org/your-repo
119+
Info: Using GITHUB_TOKEN for platform-specific authentication
120+
────────────────────────── Creating/touching session ───────────────────────────
121+
Session ID: abc123-def456-ghi789
122+
Uploading manifest from path "target/manifest.json"
123+
Uploading catalog from path "target/catalog.json"
124+
Notifying upload completion...
125+
──────────────────────────── Uploaded Successfully ─────────────────────────────
126+
Uploaded dbt artifacts to Recce Cloud for session ID "abc123-def456-ghi789"
127+
Artifacts from: "/home/runner/work/your-repo/your-repo/target"
128+
```
129+
108130
## Next Steps
109131

110132
**[Setup CI](./setup-ci.md)** to automatically validate PR changes against your updated base session. This completes your CI/CD pipeline by adding automated data validation for every pull request.

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,32 @@ jobs:
103103

104104
![Recce Cloud showing PR validation session](../../assets/images/7-cicd/verify-setup-github-ci.png){: .shadow}
105105

106+
#### Expected Output
107+
108+
When the upload succeeds, you'll see output like this in your workflow logs:
109+
110+
```
111+
─────────────────────────── CI Environment Detection ───────────────────────────
112+
Platform: github-actions
113+
PR Number: 42
114+
PR URL: https://github.com/your-org/your-repo/pull/42
115+
Session Type: cr
116+
Commit SHA: abc123de...
117+
Base Branch: main
118+
Source Branch: feature/your-feature
119+
Repository: your-org/your-repo
120+
Info: Using GITHUB_TOKEN for platform-specific authentication
121+
────────────────────────── Creating/touching session ───────────────────────────
122+
Session ID: f8b0f7ca-ea59-411d-abd8-88b80b9f87ad
123+
Uploading manifest from path "target/manifest.json"
124+
Uploading catalog from path "target/catalog.json"
125+
Notifying upload completion...
126+
──────────────────────────── Uploaded Successfully ─────────────────────────────
127+
Uploaded dbt artifacts to Recce Cloud for session ID "f8b0f7ca-ea59-411d-abd8-88b80b9f87ad"
128+
Artifacts from: "/home/runner/work/your-repo/your-repo/target"
129+
Change request: https://github.com/your-org/your-repo/pull/42
130+
```
131+
106132
#### Review PR Session
107133

108134
To analyze the PR changes in detail:

docs/7-cicd/gitlab/setup-cd.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,28 @@ To enable automatic baseline updates:
191191

192192
![Recce Cloud showing updated base sessions](../../assets/images/7-cicd/verify-setup-gitlab-cd.png){: .shadow}
193193

194+
#### Expected Output
195+
196+
When the upload succeeds, you'll see output like this in your pipeline logs:
197+
198+
```
199+
─────────────────────────── CI Environment Detection ───────────────────────────
200+
Platform: gitlab-ci
201+
Session Type: prod
202+
Commit SHA: a1b2c3d4...
203+
Source Branch: main
204+
Repository: your-org/your-project
205+
Info: Using CI_JOB_TOKEN for platform-specific authentication
206+
────────────────────────── Creating/touching session ───────────────────────────
207+
Session ID: abc123-def456-ghi789
208+
Uploading manifest from path "target/manifest.json"
209+
Uploading catalog from path "target/catalog.json"
210+
Notifying upload completion...
211+
──────────────────────────── Uploaded Successfully ─────────────────────────────
212+
Uploaded dbt artifacts to Recce Cloud for session ID "abc123-def456-ghi789"
213+
Artifacts from: "/builds/your-org/your-project/target"
214+
```
215+
194216
#### Verify Scheduled Runs
195217

196218
1. Go to **CI/CD → Schedules**

docs/7-cicd/gitlab/setup-ci.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,32 @@ The command automatically uses your GitLab CI environment for authentication (vi
121121

122122
![Recce Cloud showing MR validation session](../../assets/images/7-cicd/verify-setup-gitlab-ci.png){: .shadow}
123123

124+
#### Expected Output
125+
126+
When the upload succeeds, you'll see output like this in your pipeline logs:
127+
128+
```
129+
─────────────────────────── CI Environment Detection ───────────────────────────
130+
Platform: gitlab-ci
131+
MR Number: 4
132+
MR URL: https://gitlab.com/recce/staging-jaffle-shop-snowflake/-/merge_requests/4
133+
Session Type: cr
134+
Commit SHA: c928e3d5...
135+
Base Branch: main
136+
Source Branch: feature/replace-recce-cicd-component-with-recce-cloud-cli
137+
Repository: recce/staging-jaffle-shop-snowflake
138+
Info: Using CI_JOB_TOKEN for platform-specific authentication
139+
────────────────────────── Creating/touching session ───────────────────────────
140+
Session ID: f8b0f7ca-ea59-411d-abd8-88b80b9f87ad
141+
Uploading manifest from path "target/manifest.json"
142+
Uploading catalog from path "target/catalog.json"
143+
Notifying upload completion...
144+
──────────────────────────── Uploaded Successfully ─────────────────────────────
145+
Uploaded dbt artifacts to Recce Cloud for session ID "f8b0f7ca-ea59-411d-abd8-88b80b9f87ad"
146+
Artifacts from: "/builds/recce/staging-jaffle-shop-snowflake/target"
147+
Change request: https://gitlab.com/recce/staging-jaffle-shop-snowflake/-/merge_requests/4
148+
```
149+
124150
#### Review MR Session
125151

126152
To analyze the MR changes in detail:
@@ -129,12 +155,6 @@ To analyze the MR changes in detail:
129155
- Find the MR session that was created
130156
- Launch Recce instance to explore data differences
131157

132-
Or use the session launch URL from the pipeline output:
133-
```bash
134-
# Pipeline output example
135-
RECCE_SESSION_LAUNCH_URL: https://cloud.reccehq.com/launch/abc123
136-
```
137-
138158
## Troubleshooting
139159

140160
### Missing dbt files

0 commit comments

Comments
 (0)