Configuring CI Using Jenkins and Nx
Below is an example of a Jenkins setup, building and testing only what is affected.
1pipeline {
2 agent none
3 environment {
4 NX_BRANCH = env.BRANCH_NAME.replace('PR-', '')
5 }
6 stages {
7 stage('Pipeline') {
8 parallel {
9 stage('Main') {
10 when {
11 branch 'main'
12 }
13 agent any
14 steps {
15 // This line enables distribution
16 // The "--stop-agents-after" is optional, but allows idle agents to shut down once the "e2e-ci" targets have been requested
17 // sh "npx nx-cloud start-ci-run --distribute-on='3 linux-medium-js' --stop-agents-after='e2e-ci'"
18 sh "npm ci"
19 // Enable Nx Cloud recording to track build performance over time
20 // This requires connecting your workspace to Nx Cloud. Run "nx connect" and set the NX_CLOUD_ACCESS_TOKEN env variable in your CI
21 // sh "npx nx-cloud record -- nx format:check"
22
23 // Without Nx Cloud, run format:check directly
24 sh "npx nx format:check"
25 sh "npx nx affected --base=HEAD~1 -t lint test build e2e-ci"
26 }
27 }
28 stage('PR') {
29 when {
30 not { branch 'main' }
31 }
32 agent any
33 steps {
34 // This line enables distribution
35 // The "--stop-agents-after" is optional, but allows idle agents to shut down once the "e2e-ci" targets have been requested
36 // sh "npx nx-cloud start-ci-run --distribute-on='3 linux-medium-js' --stop-agents-after='e2e-ci'"
37 sh "npm ci"
38 // Enable Nx Cloud recording to track build performance over time
39 // This requires connecting your workspace to Nx Cloud. Run "nx connect" and set the NX_CLOUD_ACCESS_TOKEN env variable in your CI
40 // sh "npx nx-cloud record -- nx format:check"
41
42 // Without Nx Cloud, run format:check directly
43 sh "npx nx format:check"
44 sh "npx nx affected --base origin/${env.CHANGE_TARGET} -t lint test build e2e-ci"
45 }
46 }
47 }
48 }
49 }
50}
51Get the Commit of the Last Successful Build
Unlike GitHub Actions and CircleCI, you don't have the metadata to help you track the last successful run on main. In the example below, the base is set to HEAD~1 (for push) or branching point (for pull requests), but a more robust solution would be to tag an SHA in the main job once it succeeds and then use this tag as a base. See the nx-tag-successful-ci-run and nx-set-shas (version 1 implements tagging mechanism) repositories for more information.
We also have to set NX_BRANCH explicitly.