Public Cloud Github 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. 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.

After installing the Nx Cloud app, you will need to update your CI pipeline to include two new env variables:

  • NX_BRANCH: should be a PR number or branch name

  • NX_RUN_GROUP: can be a job ID. It can also be left blank -- Nx will group runs based on some heuristics

Setting Variables in Azure Pipelines

variables: NX_BRANCH: $(System.PullRequestNumber) NX_RUN_GROUP: $(Build.BuildNumber)

Setting Variables in GitHub Actions

env: NX_BRANCH: ${{ github.event.pull_request.head.ref }} NX_RUN_GROUP: ${{ github.run_id }}

Note: If you don't see NX_BRANCH being recognized, you can also try to use the PR number.

env: NX_BRANCH: ${{ github.event.number }} NX_RUN_GROUP: {{ github.run_id }}

Setting Variables in Travis CI

NX_BRANCH and NX_RUN_GROUP will be set automatically based on the env variables provided by Travis CI, so there is no additional setup required.

You can always explicitly set these values.

Setting Variables in CircleCI

Make sure you have GitHub checks enabled on your CircleCI dashboard. Instructions can be found here.

NX_BRANCH and NX_RUN_GROUP will be set automatically based on the env variables provided by CircleCI, so there is no additional setup required.

You can always explicitly set these values.

Select an article to learn more about Nx Cloud