Skip to content

adding page on upgrading permisssions #210

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
merged 1 commit into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/getting-started/upgrading-permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Upgrading App Permissions
description: Learn how to upgrade CodeRabbit's GitHub App permissions when new features are added
sidebar_label: Upgrading Permissions
sidebar_position: 6
---

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:

1. Navigate to your organization or repository settings in GitHub
2. Go to the "GitHub Apps" or "Installed GitHub Apps" section
3. Find CodeRabbit in the list of installed apps
4. Click "Configure"
5. Review and accept the new permissions

![Permission warning example](../../static/img/getting-started/permission-warning.png)

![Granting updated permissions](../../static/img/getting-started/grant-permission.png)

Common reasons for permission updates include:

- Access to new GitHub features
- Enhanced repository scanning capabilities
- Additional workflow automation features
- Improved security features

> Note: If you're not an organization admin, you may need to request approval from your organization administrators to update the permissions.

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.
Binary file added static/img/getting-started/permission-warning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading