Quickstart Guide

Connect a repository and check your first review in the current Codity Platform.

Prerequisites

Use an account that can access the repository and authorize the provider integration. Installing a GitHub App or creating project webhooks may require a repository or organization administrator. Select the account that owns the repositories you want to review.

Step 1: Sign In

  1. Open your Codity Platform sign-in page and choose GitHub, GitLab, Azure DevOps or Bitbucket. Self-hosted GitLab has a separate option in the GitLab menu.
  2. Complete authorization with the provider.
  3. Follow the welcome screen to complete your profile and select the offered personal, organization, group or workspace access. The options depend on the provider.
  4. Check the active account shown in the dashboard. Account scope affects repositories, teams, subscription and usage.

For an email-based Codity account, follow Codity Accounts. Email sign-in does not connect a VCS provider.

Step 2: Connect Your Repository

Open Repositories. Use the action for your provider:

Provider Action Detailed setup
GitHub Add Repositories opens the GitHub App installation flow GitHub
GitLab.com Enable Repositories opens GitLab Repositories; configure a PAT there if needed GitLab.com
Self-hosted GitLab Open the repositories for your connected instance and scope Self-hosted GitLab
Azure DevOps Manage Repositories opens the selected organization's repositories Azure DevOps
Bitbucket Enable Repositories opens the selected workspace's repositories Bitbucket

Complete that provider's credential and repository-selection steps. Signing in alone does not enable every repository.

Step 3: Create a Test Pull Request

Open a small pull request or merge request in an enabled repository. Choose a target branch allowed by your review configuration. For a controlled test, use a repository where you are authorized to create branches and PRs.

For example, create docs-integration-check from an allowed target such as main, make a small source-code change with a clear purpose, and open the PR/MR back into that target. A documentation-only change may contain no reviewable source code, so it is not a reliable test of every review or scan pipeline.

Before opening it, check that automatic reviews are enabled for that repository, that main is actually an allowed target in your configuration, and that no opt-out marker suppresses the event. The example branch names are illustrative; use your repository's workflow.

Step 4: Wait for Review

Check the PR or MR for Codity activity and the dashboard for review status. Completion time depends on the change size, enabled checks and queue; it is not a fixed one-to-three-minute guarantee.

Step 5: Review the Feedback

Read the summary and any inline findings. A finding may include severity, an explanation and a suggested change. A review with no findings can still complete successfully.

  1. Check whether the run completed, failed or was skipped before interpreting its findings.
  2. Read each finding alongside the referenced code and verify the described scenario.
  3. Apply an appropriate correction through your normal development workflow.
  4. If you push another change, check the effective trigger: On PR open does not promise a new full review on every push. On every commit remains subject to incremental handling.
  5. If you want a review explicitly, post @codity review as its own PR/MR comment. Repository authorization and usage restrictions still apply.

Step 6: Provide Feedback (Optional)

Use the feedback controls available on the review. For accepted or intentionally deferred findings, see Finding Acknowledgements.

Verify It's Working

Confirm the repository is enabled, the PR/MR is eligible for review and a completed review is visible. If nothing starts, check the provider guide's troubleshooting, webhook delivery and When Reviews Run. Changing repository credentials, account scope or required checks can affect this flow.

Observation What it establishes What to check next
Provider sign-in succeeds The dashboard has an authenticated provider identity. Select the correct account and complete repository integration.
Repository appears and is enabled The repository is connected in the current scope. Verify review trigger, target branch and notification delivery.
Webhook delivery succeeds A provider event reached the integration endpoint. Inspect run eligibility and status.
Review completes without findings That run finished without reportable findings. Inspect its scope and enabled checks; this is not proof the code has no defects.
Findings appear in a summary table The review produced consolidated output. Check Concise mode if you expected inline discussions.

If setup still fails, use Help and Support Requests. Include the provider, account, repository, PR/MR and non-sensitive error details so the failing stage can be identified.