|
1 | 1 | --- |
2 | | -title: AI Summary |
| 2 | +title: PR/MR Summary |
3 | 3 | --- |
| 4 | +Recce provides summary of each PR for you to understand the change and the impact. Recce Summary uses a template-based format, while AI Summary is dynamically generated by AI agents for more intelligent analysis. |
4 | 5 |
|
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 | +## Recce Summary |
| 8 | +Recce allows to generate a summary for a PR based on the updated metadata and the run result of the checklist and post the summary on your PR/MR comment |
| 9 | + |
| 10 | +Recce Summary uses a template-based format and includes: lineage graph, check results, and launch URL. |
| 11 | + |
| 12 | +### How to generate |
| 13 | + |
| 14 | +1. **Trigger via CI Automation**: Summary is automatically generated when Recce runs in your CI workflow. |
| 15 | + |
| 16 | +2. **Trigger via Recce Cloud**: In the Recce Cloud PR/MR session list, click **Execute Recce Summary** to manually generate the analysis. |
| 17 | + |
| 18 | + > Note: This action is only available after the session metadata has been updated. |
| 19 | +
|
| 20 | +## AI Summary |
6 | 21 |
|
7 | 22 | 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 | 23 |
|
9 | | -Features |
| 24 | +**Features** |
10 | 25 |
|
11 | 26 | - Automatically identify what to validate |
12 | 27 | - Explore changes through data diffing in Recce |
13 | 28 | - Generate actionable insights to guide your merge decision |
14 | 29 |
|
15 | | -## How to Use |
16 | | - |
17 | | -### 1. Trigger via Recce Cloud UI |
18 | | - |
19 | | -Go to the Recce Cloud PR/MR session list and click the **"Execute Recce AI Summary"** button to manually trigger the analysis. |
| 30 | +### How to generate |
20 | 31 |
|
21 | | -### 2. Trigger via GitHub PR Comment (GitHub only) |
22 | 32 |
|
23 | | -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. |
24 | 33 |
|
25 | | -{: .shadow} |
| 34 | +1. **Trigger via Recce Cloud**: In the Recce Cloud PR/MR session list, click **Execute Recce AI Summary** to generate the analysis. |
26 | 35 |
|
27 | | -**Emoji Feedback:** |
| 36 | +2. **Trigger via GitHub PR Comment (GitHub only)**: In your GitHub PR page, comment `/recce` to trigger the AI Summary generation. The Recce bot will respond with status updates. |
28 | 37 |
|
29 | | -- π : Request received |
30 | | -- π : Summary is generating |
31 | | -- π : Summary is generated |
| 38 | + {: .shadow} |
32 | 39 |
|
33 | | -### 3. Trigger via CI Automation (Coming Soon) |
| 40 | + Progress Indicators: |
34 | 41 |
|
35 | | -AI Summary will be automatically generated by default when you update metadata for your PR through CI, eliminating the need for manual triggering. |
| 42 | + - π : Request received |
| 43 | + - π : Summary is generating |
| 44 | + - π : Summary is generated |
36 | 45 |
|
| 46 | +3. **Trigger via CI Automation (Coming Soon)**: AI Summary will be automatically triggered when you update PR metadata through CI. |
0 commit comments