Skip to main content

Documentation · GitHub access

Know exactly what Qedix requests.

Qedix uses a GitHub App for selected repository access and GitHub OAuth for user sign-in. Administrators should review GitHub's authorization screens before granting access.

Repository permissions

These permissions apply only to repositories included in the GitHub App installation.

Permission

Metadata

Access

Read

Why it is needed

Identify the repository and installation context associated with a supported GitHub event.

Product boundary

Qedix does not use this permission to modify repository settings.

Permission

Contents

Access

Read

Why it is needed

Retrieve repository content required to analyze the pull-request changes in a selected repository.

Product boundary

Qedix does not use this permission to commit, push, or rewrite repository content.

Permission

Pull requests

Access

Read

Why it is needed

Read pull-request metadata, commit references, changed files, and supported pull-request activity.

Product boundary

Qedix does not use this permission to merge, close, or approve pull requests.

Permission

Checks

Access

Read and write

Why it is needed

Create and update the advisory Qedix Check associated with an analysis run.

Product boundary

A Qedix Check communicates evidence and recommendation status; it does not deploy code.

Repository selection

Administrators choose which repositories are connected.

Selected repositories

Choose only the repositories that require Qedix review. This is the recommended least-access installation option.

All repositories

If an administrator grants access to all repositories, newly created repositories may also become available to the installation according to GitHub's behaviour.

GitHub sign-in

User authentication is separate from GitHub App repository installation.

read:user

Reads the GitHub profile information needed to identify the user signing in to Qedix.

user:email

Reads the email information GitHub makes available for the authenticated account.

Signing in does not independently grant repository access. Repository availability depends on the Qedix GitHub App installation and the user's authorized workspace access.

Subscribed events

Qedix receives only the GitHub App events configured for its workflow.

Pull request

Starts or updates analysis when supported pull-request activity occurs in a connected repository.

Installation

Keeps the Qedix workspace aligned with GitHub App installation changes.

Installation repositories

Tracks repositories added to or removed from an existing GitHub App installation.

What these permissions do not authorize

GitHub access does not transfer the maintainer's decision authority to Qedix.

  • Automatically merge a pull request
  • Automatically deploy an application
  • Commit or push source-code changes
  • Modify repository administration settings
  • Replace branch protection or maintainer review
  • Guarantee that a pull request is safe

Manage or remove access

Authorized GitHub administrators can change the installation at any time.

Change selected repositories

Open the Qedix installation in GitHub settings and update the repository selection.

Remove the installation

Uninstalling the GitHub App stops future access through that installation. Review branch-protection rules if a Qedix Check was configured as required.

Read uninstall guidance →