Skip to content

docs(app-connections): explicitly state fine-grained PAT requirement for GitHub connection#6891

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1781641701-docs-github-pat-fine-grained
Open

docs(app-connections): explicitly state fine-grained PAT requirement for GitHub connection#6891
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1781641701-docs-github-pat-fine-grained

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Context

Community users reported confusion when setting up GitHub Sync via the PAT method — the requirement for a fine-grained Personal Access Token (as opposed to a classic token) was only apparent from the screenshots and not stated in the text. Additionally, users with private repos discovered the token owner needs admin access on the repository for it to appear in the sync destination list.

This PR updates the GitHub Connection docs (PAT tab) to:

  • Add a prominent note that a fine-grained PAT is required (classic tokens are not supported)
  • Update headings/instructions to say "Fine-Grained" explicitly
  • Rename "Select scopes" → "Permissions > Repository permissions" to match the actual GitHub fine-grained token UI
  • Add a warning that private repos require the token owner to have admin access

Steps to verify the change

  1. Navigate to the GitHub Connection docs page and select the "Personal Access Token" tab
  2. Verify the note about fine-grained tokens is visible at the top
  3. Verify the warning about admin access for private repos appears under the permissions list

Type

  • Fix
  • Feature
  • Improvement
  • Breaking
  • Docs
  • Chore

Checklist

  • Title follows the conventional commit format: type(scope): short description (scope is optional, e.g., fix: prevent crash on sync or fix(api): handle null response).
  • Tested locally
  • Updated docs (if needed)
  • Updated CLAUDE.md files (if needed)
  • Read the contributing guide

Link to Devin session: https://app.devin.ai/sessions/d2951e412f754c25b6b56af91d89275e

…tion

- Add a note at the top of the PAT tab clarifying that a fine-grained
  token is required and classic tokens are not supported
- Update headings and instructions to say 'Fine-Grained' explicitly
- Rename 'Select scopes' to 'Permissions > Repository permissions' to
  match the actual GitHub UI for fine-grained tokens
- Add a warning that private repo access requires the token owner to
  have admin access on the repository

Co-Authored-By: jake <jake@infisical.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@mintlify

mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
infisical 🟢 Ready View Preview Jun 16, 2026, 8:32 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@greptile-apps

greptile-apps Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR improves clarity in the GitHub Connection docs (PAT tab) by explicitly calling out that a fine-grained Personal Access Token is required (classic tokens unsupported) and noting that private repo owners need admin access for repos to appear in the sync destination list.

  • Adds a <Note> block at the top of the PAT tab and updates all headings/instructions to say "Fine-Grained".
  • Renames "Select scopes" to "Permissions > Repository permissions" to match the actual GitHub fine-grained token UI.
  • Adds a <Warning> inside the permissions step for the admin access requirement on private repos.

Confidence Score: 5/5

Purely a documentation update with no code changes; safe to merge.

The single changed file is an .mdx doc page. The added Note and Warning are accurate and use correct Mintlify components. The permission labels ("Metadata", "Environments", "Secrets") and UI navigation path match GitHub's fine-grained PAT interface. No logic, configuration, or runtime behaviour is affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/integrations/app-connections/github.mdx Documentation improvements to the PAT tab: adds a Note about fine-grained token requirement, updates headings and instructions to say "Fine-Grained", renames "Select scopes" to match the actual GitHub UI, and adds a Warning about admin access for private repos.

Reviews (1): Last reviewed commit: "docs: explicitly state fine-grained PAT ..." | Re-trigger Greptile

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b1808d6d2a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +227 to 230
- **Permissions:** Under **Repository permissions**, add the following:
- **Metadata**: Read-only
- **Environments**: Read and write
- **Secrets**: Read and write

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document org PAT permissions for organization sync

When a PAT connection is used with GitHub Sync's Organization scope, this list only tells users to grant repository permissions, but the backend lists and writes org secrets through /orgs/{org}/actions/secrets (see GithubSyncFns in backend/src/services/secret-sync/github/github-sync-fns.ts). Fine-grained PATs need the organization-level Secrets permission for those endpoints, so tokens created from this guide can validate and list repos but fail during organization-level sync; please add the org Secrets permission/resource-owner instructions or mark the PAT guide as repository-scope only.

Useful? React with 👍 / 👎.

@jakehulberg jakehulberg requested a review from dangtony98 June 16, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant