Skip to content

Commit 4ff9968

Browse files
committed
Add AI summary
Signed-off-by: popcorny <[email protected]>
1 parent bdb4eed commit 4ff9968

File tree

3 files changed

+37
-2
lines changed

3 files changed

+37
-2
lines changed

β€Ždocs/7-cicd/pr_mr_summary.mdβ€Ž

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: AI Summary
3+
---
4+
5+
When the CI task is executed, it generates a lineage and checks report for your PR/MR. However, the report uses a fixed format and lacks PR-specific context.
6+
7+
AI Summary leverages state-of-the-art AI agents to understand your changes by analyzing your PR information and updated metadata. It proactively thinks and decides what to validate by data diffing in your data warehouse, then provides comprehensive insights to help you make informed decisions.
8+
9+
Features
10+
- Automatically identify what to validate
11+
- Explore changes through data diffing in Recce
12+
- Generate actionable insights to guide your merge decision
13+
14+
## How to Use
15+
16+
### 1. Trigger via GitHub PR Comment (GitHub only)
17+
18+
In your GitHub PR page, simply comment `/recce` to trigger the AI Summary generation. The Recce bot will respond with emoji feedback to show the progress of the analysis.
19+
20+
![AI Summary slash command example](../assets/images/7-cicd/ai-summary-slash-command.png){: .shadow}
21+
22+
**Emoji Feedback:**
23+
24+
- πŸ‘€ : Request received
25+
- πŸš€ : Summary is generating
26+
- πŸ‘ : Summary is generated
27+
28+
### 2. Trigger via Recce Cloud UI
29+
30+
Go to the Recce Cloud PR/MR session list and click the **"Execute Recce AI Summary"** button to manually trigger the analysis.
31+
32+
### 3. Trigger via CI Automation (Coming Soon)
33+
34+
AI Summary will be automatically generated by default when you update metadata for your PR through CI, eliminating the need for manual triggering.
35+
13.2 KB
Loading

β€Žmkdocs.ymlβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ nav:
9191
- 7-cicd/gitlab/setup-ci.md
9292
- 7-cicd/gitlab/setup-cd.md
9393
- 7-cicd/gitlab/gitlab-pat-guide.md
94-
94+
- 7-cicd/pr_mr_summary.md
9595
#- 7-cicd/recce-debug.md # content outdated
96-
- 7-cicd/scenario-dev.md
96+
- 7-cicd/scenario-dev.md
9797
- 7-cicd/scenario-pr-review.md
9898
- 7-cicd/best-practices-prep-env.md
9999
#- 7-cicd/recce-summary.md content outdated

0 commit comments

Comments
Β (0)