Enable Github PR Integration

Get Started

The Nx Cloud Github App lets you access the result of every run—with all its logs and build insights—straight from your PR.

Nx Public Cloud CI Setup

Before you install the app, please make sure you have a valid Nx Cloud accessToken in your nx.json file. Nx Cloud reports will not generate properly on your PRs without one. You should already have one if you’re using Nx Cloud, but if you don’t, you can learn how to add one here.

You can find and install the app from the GitHub marketplace.

If you are using CircleCI, TravisCI, GitHub Actions or GitHub, there is nothing else you need to do. If you are using other CI providers, you need to set the NX_BRANCH environment variable in your CI configuration. The variable has to be set to a PR number.

For instance, this is an example of doing it in Azure pipelines.

Azure Pipelines

1variables:
2  NX_BRANCH: $(System.PullRequest.PullRequestNumber)
3

CircleCI

Make sure GitHub checks are enabled.

Jenkins

Install the Jenkins plugin.

Ensure this step from the plugin instructions is followed:

Prerequisite: only GitHub App with proper permissions can publish checks, this guide helps you authenticate your Jenkins as a GitHub App.