Skip to content

Commit 119fb4b

Browse files
correct details
1 parent c6f2a32 commit 119fb4b

File tree

1 file changed

+92
-7
lines changed

1 file changed

+92
-7
lines changed

docs/guides/scheduled-reports.md

+92-7
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,71 @@ CodeRabbit Pro offers automated recurring reports that provide insights into you
2323

2424
![Schedule Configuration](/img/guides/report-params.png)
2525

26-
- **Frequency**: Choose between weekly, monthly, or custom intervals
27-
- **Days**: Select specific days of the week or month
28-
- **Time**: Set the time for report generation in your timezone
26+
The schedule configuration allows you to set precise timing for your reports:
2927

30-
:::note
31-
Reports summarize events between scheduled intervals. For example, a Monday report will include activities from Friday through Monday.
28+
#### Frequency Options
29+
30+
- **Days of Week**
31+
- Select any combination of days (Sun-Sat)
32+
- Set frequency (every 1-3 weeks)
33+
- Ideal for weekly team syncs or sprint reviews
34+
35+
- **Days of Month**
36+
- Select specific dates (1-31)
37+
- Special date handling:
38+
- 31st: Runs on the last day of every month
39+
- 30th: Skips February
40+
- 29th: Only runs in February during leap years
41+
42+
#### Time Settings
43+
44+
- Set specific time for report generation
45+
- Choose from comprehensive timezone list (e.g., America/New_York)
46+
- Reports run at the specified time in the selected timezone
47+
48+
:::tip Timezone Consideration
49+
Choose a time that works for all team members, especially for distributed teams across different time zones.
3250
:::
3351

3452
### Report Parameters
3553

54+
Reports can be filtered using multiple parameters:
55+
3656
- **Repositories**: Select specific repositories to monitor
37-
- **Labels**: Filter by specific GitHub labels
57+
- **Labels**: Filter by GitHub labels with operators:
58+
- IN: Match any selected label
59+
- ALL: Match all selected labels
3860
- **Users**: Filter by specific GitHub users
39-
- **Teams**: Narrow focus to specific teams within your organization
61+
- **Teams**: Filter by organization teams
62+
- Note: Team filtering is not available for GitLab repositories
63+
64+
:::note Parameter Configuration
65+
Each parameter can be:
66+
67+
- Added or removed as needed
68+
- Combined with other parameters for precise filtering
69+
- Modified using different operators
70+
:::
71+
72+
### Report Content
73+
74+
Reports include comprehensive PR information:
75+
76+
- PR metadata:
77+
- Title and description
78+
- Creation and last activity dates
79+
- Status (merged, mergeable, draft)
80+
- State (open, closed, merged)
81+
- Collaboration details:
82+
- Labels and reviewers
83+
- Comments and discussions
84+
- Team associations
85+
- Repository context
86+
- Author information
87+
88+
:::info Stale PR Detection
89+
PRs are marked as stale after 168 hours (7 days) of inactivity. This helps identify potential workflow bottlenecks.
90+
:::
4091

4192
### Report Templates
4293

@@ -104,6 +155,40 @@ Organize report content by:
104155

105156
This helps keep information organized for larger organizations or teams.
106157

158+
### Report Lifecycle Management
159+
160+
Control your reports through their entire lifecycle:
161+
162+
#### Editing Reports
163+
164+
- Make your desired changes to any configuration settings
165+
- Click the **Save** button to apply your changes
166+
- Changes take effect from the next scheduled run
167+
168+
:::tip
169+
Remember to click **Save** when you're done making changes. Your modifications will be discarded if you navigate away without saving.
170+
:::
171+
172+
#### Disabling Reports
173+
174+
- Toggle the **Active** switch to temporarily pause a report
175+
- Disabled reports:
176+
- Maintain their configuration
177+
- Skip scheduled runs
178+
- Can be re-enabled at any time
179+
- Show "Disabled" status in the dashboard
180+
181+
#### Deleting Reports
182+
183+
- Click the **Delete** button (trash icon) next to the report
184+
- Confirm deletion in the modal
185+
- Note: This action is permanent and cannot be undone
186+
- All report history and configuration will be removed
187+
188+
:::warning
189+
Deleting a report will immediately stop all scheduled runs and remove access to historical reports. Consider disabling instead of deleting if you might need the report again.
190+
:::
191+
107192
## Best Practices
108193

109194
1. **Scheduling**

0 commit comments

Comments
 (0)