You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Learn how to upgrade CodeRabbit's GitHub App permissions when new features are added
4
+
sidebar_label: Upgrading Permissions
5
+
sidebar_position: 6
6
+
---
7
+
8
+
Sometimes when we add new features to CodeRabbit, we need to request additional GitHub permissions. If you see a warning about permissions or resources not being accessible, you'll need to approve the new permissions. Here's how to do it:
9
+
10
+
1. Navigate to your organization or repository settings in GitHub
11
+
2. Go to the "GitHub Apps" or "Installed GitHub Apps" section
> Note: If you're not an organization admin, you may need to request approval from your organization administrators to update the permissions.
28
+
29
+
After accepting the new permissions, CodeRabbit will have the access it needs to function properly. If you continue to experience issues, try refreshing your browser or reaching out to our support team.
Copy file name to clipboardExpand all lines: docs/guides/custom-reports.md
+54-1
Original file line number
Diff line number
Diff line change
@@ -274,10 +274,63 @@ Include:
274
274
- Technical debt analysis
275
275
```
276
276
277
-
###Advanced Formatting
277
+
## Advanced Example Templates
278
278
279
279
Heres a more advanced example of a custom report template:
280
280
281
+
### **Good Day Release Report**
282
+
283
+
```text
284
+
**GPT Specialization:**
285
+
This GPT specializes in summarizing software release notes and optional summary paragraphs into a consistent, clear, and concise format. The goal is to streamline the presentation of release notes, making them easy to understand for a general audience. It prioritizes clarity, brevity, and coherence while highlighting important updates without unnecessary jargon.
286
+
287
+
**Release Note Structure:**
288
+
289
+
1. **Release Notes Organization**
290
+
The items in the release notes may not be in the desired order. It is crucial to group similar items together meaningfully. Review the list after the release notes are created and reorder items within each heading based on relevance. Use **PRODUCT FEATURE GROUPS** to understand which items are related.
291
+
292
+
2. **General Release Note Guidelines**
293
+
- The title should be: `GoodDay Release v${versionNumber}`
294
+
295
+
3. **Release Note Line Items**
296
+
- Reword individual release lines to maintain a consistent tone (happy and fun)
297
+
- Use past tense for descriptions
298
+
- Items in the 🧼 Fixes group should begin with "Fixed"
299
+
- Consolidate duplicate or closely related items, and list the associated GitHub pull requests as a comma-delimited list at the end (e.g., GH-123, GH-456)
300
+
- Add links to Github App for each PR
301
+
302
+
4. **GitHub App Links**
303
+
- each pr mentioned should include hyperlinking to the pull request such as [coderabbitai/mono/pull/2614](https://github.com/coderabbitai/mono/pull/2614)
304
+
305
+
5. **Grouping Release Note Line Items**
306
+
- Replace any emoji in the provided content with the appropriate **RELEASE NOTE GROUP**
307
+
- Order the **RELEASE NOTE GROUP** according to the structure below
308
+
309
+
6. **Release Note Groups**
310
+
- 🚀 **Features**: New capabilities or enhancements
311
+
- 🧼 **Fixes**: Bug fixes or problem resolutions
312
+
- 🧰 **Maintenance**: Documentation, cleanup, or technical changes
313
+
- 📚 **Other**: Anything else
314
+
315
+
7. **PR Label Uses**
316
+
- Omit any PRs with the label `skip-changelog`
317
+
- Use the labels from related pull requests to group items together
318
+
- Map PR labels to release note groups using the table below:
319
+
320
+
| RELEASE NOTE GROUP | LABELS |
321
+
|--------------------|-----------------|
322
+
| 🚀 Features | feature, enhancement |
323
+
| 🧼 Fixes | bug, fix |
324
+
| 🧰 Maintenance | design, docs |
325
+
| 📚 Other | other, tech |
326
+
327
+
8. **Final Checks**
328
+
- Verify that the number of items matches the number of PRs included
329
+
- Ensure the PR links match the PR number and reflect the content of the changes
330
+
```
331
+
332
+
### **Nato's Special Report**
333
+
281
334
```text
282
335
Generate a report of all pull requests in the following format:
@@ -10,23 +10,23 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10
10
<ProPlanNotice />
11
11
```
12
12
13
-
[Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects
13
+
[`detekt`](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects
14
14
15
15
## Files
16
16
17
-
Detekt will run on files with the following extensions:
17
+
`detekt` will run on files with the following extensions:
18
18
19
19
-`.kt`
20
20
-`.kts`
21
21
22
22
## Configuration
23
23
24
-
Detekt uses a YAML style configuration file.
24
+
`detekt` uses a YAML style configuration file.
25
25
26
-
Detekt supports the following config files:
26
+
`detekt` supports the following config files:
27
27
28
-
- User-defined config file set at `reviews.tools.detekt.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Detekt → Config File" field in CodeRabbit's settings page.
28
+
- User-defined config file set at `reviews.tools.detekt.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → `detekt` → Config File" field in CodeRabbit's settings page.
Copy file name to clipboardExpand all lines: docs/tools/semgrep.md
+25-46
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,13 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10
10
<ProPlanNotice />
11
11
```
12
12
13
-
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code
14
-
for security vulnerabilities and code quality issues.
13
+
[Semgrep](https://github.com/semgrep/semgrep) is an open-source static analysis tool designed to scan code for security vulnerabilities and code quality issues.
15
14
16
15
## Configuration
17
16
18
-
Semgrep uses a YAML style configuration file. By default we will automatically
17
+
Semgrep uses a YAML style configuration file. By default, we will automatically
19
18
use the following files if any are set in the root directory of your
20
-
repostitory.
19
+
repository.
21
20
22
21
-`semgrep.yml` or `semgrep.yaml`
23
22
-`semgrep.config.yml` or `semgrep.config.yaml`
@@ -28,10 +27,12 @@ Semgrep supports the following config files:
28
27
project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep →
29
28
Config File" field in CodeRabbit's settings page.
30
29
31
-
Due to licensing, CodeRabbit does not ship with the [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules), but you're free to use these in your own `semgrep.yml` config file.
30
+
Due to licensing, CodeRabbit does not ship with the [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules).
32
31
33
32
:::note
34
-
CodeRabbit will only run Semgrep if your repository contains a Semgrep config file. This config must use the default file names or you must define the path to this file in the `.coderabbit.yaml` or config UI.
33
+
34
+
CodeRabbit will only run Semgrep if your repository contains a Semgrep config file. This config must use the default file names, or you must define the path to this file in the `.coderabbit.yaml` or config UI.
35
+
35
36
:::
36
37
37
38
## Links
@@ -41,43 +42,21 @@ CodeRabbit will only run Semgrep if your repository contains a Semgrep config fi
41
42
42
43
## Files
43
44
44
-
Semgrep will run on the following files and extensions:
0 commit comments