Skip to content

Configuring Change Requests

Note

For an example of using the Change Requests feature to view daily development builds, see the guide Configure Development Spaces.

Change Requests work by accepting pull request events from GitHub. The CodeLogic GitHub App is the preferred way to send those events and authenticate with GitHub; repository webhooks are supported as an alternative. Within CodeLogic, each repository has a unique configuration, enabling custom actions for each repo.

GitHub Credentials Configuration

GitHub App vs PAT

The CodeLogic GitHub App is the preferred integration. When the app is installed on your repositories, do not create credentials that store a PAT—use installation-based authentication instead (see PAT documentation and the GitHub App). The steps below apply when you are using a PAT: for example, repository webhooks without the app, or GitHub API access for repos outside the app installation.

When you use a PAT, GitHub credentials must be configured before configuring the repository. Navigate to Admin > GitHub Credentials and select the "Create GitHub Credential" button.

Create GitHub Credential button

In the Create GitHub Credentials modal:

  • Enter the GitHub Username.
  • Enter the GitHub Personal Access Token (PAT).

Repository Configuration

To add a repository configuration, select the ellipsis Actions menu icon in the Change Request list Actions column and select Add or navigate to Admin > Change Requests and click on the Add Change Request button.

Change Request configuration modal

In the Change Request configuration modal:

  • Add a Repository URL from which the Pull Request webhook events will originate
  • Enter a Regular Expression Branch Pattern matching the branch naming used for Pull Requests
    • For example: feature/.* will match any branch name starting with feature/
  • In the "GitHub Credentials" field, if you use PAT-based credentials, select the GitHub Credentials Username that you configured. When you use only the CodeLogic GitHub App for this repository, you do not need a PAT here—follow the app documentation instead of creating PAT credentials.
  • Select a Comparison Workspace that contains the scanned code into which the Pull Request will be merged
  • Choose a Retention Period for how long the server should retain the comparisons

Next, use the CodeLogic GitHub App (recommended), then Configuring GitHub Webhooks if you need a repository webhook, and Configuring Agents for how scans are matched to pull requests.