Skip to content

Improvement: GitHub app permissions #738

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.

Sign up for GitHub

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 3 commits into from
May 27, 2025
Merged

Improvement: GitHub app permissions #738

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c4b788
Correct permissions that Mintlify app requests
ethanpalm May 23, 2025
ade16f8
add read access for `metadata`
ethanpalm May 23, 2025
2612424
punctuation
ethanpalm May 23, 2025
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
6 changes: 3 additions & 3 deletions settings/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@

## Permissions

During the installation of our GitHub app, you will be prompted to grant certain
permissions:
When you install the GitHub app, you will be prompted to grant the following permissions:

- Read and write access to `checks`, `contents`, `deployments`, `pull requests`,
- **Read** access to `metadata`
- **Read** and **write** access to `checks`, `code`, `deployments`, `pull requests`,
and `workflows`

These permissions are leveraged to provide a seamless experience when managing
Expand All @@ -50,8 +50,8 @@

<Info>
If you are concerned about the write permissions, the GitHub App will only
have access to the repos you give it access to _and_ if you have branch

Check warning on line 53 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/github.mdx#L53 

Did you really mean '_and_'?
protections on it _cannot_ push directly to your branches - it abides by your

Check warning on line 54 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/github.mdx#L54 

Did you really mean '_cannot_'?
branch protection rules.
</Info>

Expand Down