Skip to main content

Documentation · Installation

Connect Qedix to selected GitHub repositories.

Installation should be completed by an authorized GitHub administrator. Review the requested access, select only the repositories that need Qedix, and verify the first pull-request check.

Before installing

Confirm the organization, authority, and repository scope before granting access.

Administrator access

Confirm that your GitHub account can install and manage GitHub Apps for the intended organization or repository owner.

Repository selection

Prepare the list of repositories where Qedix should review supported JavaScript and TypeScript pull requests.

Permission review

Read the Qedix permission guide and compare it with the authorization screen presented by GitHub.

Open permission guide →

Branch protection

Installation alone does not require making the Qedix Check a required branch-protection check. Decide that separately according to your team's review policy.

Installation steps

Complete each step in order and verify the organization and repository shown by GitHub.

  1. 01

    Confirm administrator authority

    Use a GitHub account authorized to install GitHub Apps for the intended organization or repository owner.

  2. 02

    Start from Qedix

    Open the Qedix installation flow. Qedix redirects you to GitHub to review the requested access.

  3. 03

    Review permissions

    Confirm the application identity, repository permissions, and subscribed events shown by GitHub.

  4. 04

    Select repositories

    Choose only the repositories where your team wants Qedix to review supported pull-request changes.

  5. 05

    Complete the connection

    After GitHub confirms the installation, return to Qedix and allow the installation flow to finish.

  6. 06

    Verify the first pull request

    Open or update a supported pull request and confirm that the Qedix Check appears for the expected commit.

Verify the installation

Do not treat installation as complete until the expected repository and pull-request workflow are visible.

Repository appears in Qedix

Confirm that the intended repository is visible to the authorized user in the Qedix workspace.

Check appears on the pull request

Open or update a supported pull request and confirm that the Qedix Check is associated with the expected head commit.

Analysis reaches a final state

Confirm that the check moves beyond the analyzing state and presents an advisory result or a clear failure message.

Authorized teammates can review

Verify that the intended maintainers can access the workspace and interpret the result in the context of the pull request.

Review the first report

Use the first analysis to confirm both the integration and your team's review workflow.

Confirm the commit

Verify that the report corresponds to the pull request and commit your team intended to review.

Read evidence states

Distinguish observed evidence from not-proven controls and context-dependent review.

Review suggested verification

Treat suggested tests or checks as actions for your team. Qedix does not imply that those tests were executed.

Keep the decision with maintainers

Combine Qedix evidence with tests, code review, security review, staging, and application-specific knowledge.

Read the first-report guide

Installation troubleshooting

Check the visible installation state before changing application configuration.

Repository is missing

Confirm that the repository is included in the GitHub App installation and that the signed-in user has appropriate access.

Qedix Check does not appear

Confirm the repository installation, supported pull-request activity, head commit, and GitHub App status before retrying.

Installation completed for the wrong organization

Return to GitHub installation settings, remove or reconfigure the unintended installation, and restart with the correct account.

Need support

Provide the organization, repository, pull-request number, approximate time, and visible error. Do not send credentials, tokens, or unnecessary private source code.