-
Notifications
You must be signed in to change notification settings - Fork 30
add reporting guide #187
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+611
−1
Merged
add reporting guide #187
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
4756ac6
add reporting guide
alexcoderabbitai 4933c77
🎨 pnpm run lint:fix
github-actions[bot] f8d748c
adding images and updates
alexcoderabbitai c6f2a32
add page on advanced custom reporting
alexcoderabbitai 119fb4b
correct details
alexcoderabbitai dcaaea9
last few edits
alexcoderabbitai 6392077
pnpm run lint:fix
alexcoderabbitai 3602c05
adding group details
alexcoderabbitai f6d829a
adding notes and fix position
alexcoderabbitai f617103
add docstrings command to commands
alexcoderabbitai 9842f98
add notes on different languages
alexcoderabbitai 28ee6b5
add note on languages
alexcoderabbitai 2eb8adf
fix lint
alexcoderabbitai efc5c27
fix fenced off code
alexcoderabbitai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
--- | ||
title: Scheduled Reports | ||
sidebar_label: Scheduled Reports | ||
description: Learn how to set up automated recurring reports with CodeRabbit Pro | ||
sidebar_position: 7 | ||
--- | ||
|
||
```mdx-code-block | ||
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; | ||
<ProPlanNotice /> | ||
``` | ||
|
||
CodeRabbit Pro offers automated recurring reports that provide insights into your GitHub organization's activities. These reports can be customized and delivered through various channels to help teams stay informed about development progress. | ||
|
||
## Setting Up a Recurring Report | ||
|
||
1. Navigate to **Recurring Reports** in the [CodeRabbit dashboard](https://app.coderabbit.ai/reports/recurring) | ||
2. Click **Create Report** | ||
3. Configure the following settings: | ||
|
||
### Schedule Configuration | ||
|
||
 | ||
|
||
- **Frequency**: Choose between weekly, monthly, or custom intervals | ||
- **Days**: Select specific days of the week or month | ||
- **Time**: Set the time for report generation in your timezone | ||
|
||
:::note | ||
Reports summarize events between scheduled intervals. For example, a Monday report will include activities from Friday through Monday. | ||
::: | ||
|
||
### Report Parameters | ||
|
||
- **Repositories**: Select specific repositories to monitor | ||
- **Labels**: Filter by specific GitHub labels | ||
- **Users**: Filter by specific GitHub users | ||
- **Teams**: Narrow focus to specific teams within your organization | ||
|
||
### Report Templates | ||
|
||
CodeRabbit offers several built-in templates: | ||
|
||
1. **Daily Standup Report**: A concise summary of pull requests and activities | ||
2. **Sprint Report**: A structured overview of sprint goals, completed tasks, in-progress work, and blockers | ||
3. **Release Notes**: A high-level changelog with summary and significant changes | ||
4. **Custom Templates**: Create your own format using prompts | ||
|
||
Example custom prompt: | ||
|
||
``` | ||
Please provide a summary of: | ||
- All pull request activities | ||
- Related issues and comments | ||
- Code review discussions | ||
- Quality gate status | ||
Do not include: | ||
- Bot conversations | ||
- Sequence diagrams | ||
``` | ||
|
||
### Communication Channels | ||
|
||
Configure where your reports will be delivered: | ||
|
||
 | ||
|
||
|
||
- Enter individual email addresses | ||
- Use distribution lists for team-wide delivery | ||
|
||
#### Slack/Discord | ||
|
||
1. Connect your workspace through OAuth | ||
2. Select target channels | ||
3. CodeRabbit bot will be installed automatically | ||
|
||
#### Microsoft Teams | ||
|
||
1. Create a webhook in your Teams channel | ||
2. Add the webhook URL to CodeRabbit | ||
3. Select target channels | ||
|
||
:::tip | ||
Create separate reports if you need to send to multiple channels with different formats | ||
::: | ||
|
||
## Managing Reports | ||
|
||
### Preview Reports | ||
|
||
Test your configuration using the **Preview Report** button to generate a sample report instantly. | ||
|
||
### Grouping Options | ||
|
||
Organize report content by: | ||
|
||
- Repository | ||
- Labels | ||
- Teams | ||
|
||
This helps keep information organized for larger organizations or teams. | ||
|
||
alexcoderabbitai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Best Practices | ||
|
||
1. **Scheduling** | ||
|
||
- Align report timing with your team's workflow | ||
- Consider timezone differences for distributed teams | ||
|
||
2. **Content** | ||
|
||
- Keep prompts focused on actionable information | ||
- Use grouping to improve readability | ||
- Exclude unnecessary details that may create noise | ||
|
||
3. **Distribution** | ||
- Use channels your team actively monitors | ||
- Consider creating separate reports for different audiences (e.g., management vs. development team) | ||
|
||
## Related Resources | ||
|
||
- [On-demand Reports](./ondemand-reports.md) | ||
- [API Documentation](https://api.coderabbit.ai/api/swagger/) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.