✨ Github Workflows for easily configuring distributed CI pipelines powered by the speed and intelligence of Nx Cloud.
These workflows are intended to save folks time and complexity in getting up and running with Nx Cloud and Github Actions. They are NOT intended to be a one-size-fits-all CI solution.
They will scale to workspaces of essentially any size thanks to the way they can distribute and parallelize tasks, however, that does not mean that they are infinitely configurable.
The workflows found here leverage a relatively new feature of Github called reusable workflows: https://docs.github.com/en/actions/using-workflows/reusing-workflows
The extensibility of these Nx Cloud workflows is therefore strictly bound by the capabilities of the Github feature.
This means that you cannot do things such as embed additional Github actions within the workflow, or majorly customize the steps we have set up for you.
If you find yourself needing to customize things beyond what is supported by Github reusable workflows, then the best way is to simply take a look at the source of the workflows within this repo ./.github/workflows and use that as your starting point directly within your configs.
The following will configure a CI workflow that runs on the main branch, and on all pull requests into the main branch. The CI workflow will do the following:
- Checkout your repo at the appropriate depth for determining affected projects
- Determine the
headandbaseSHAs to use fornx affected - Install nodejs
- Use an appropriate node_module caching strategy for either
yarn,npmorpnpm(depending on which one is configured in your repo) - Install locked dependencies with either
yarn,npmorpnpm(depending on which one is configured in your repo) - Spawn 3 agents ready to receive tasks/targets to run
- Initiate all the provided commands in parallel, with those defined in
parallel-commandsbeing executed on the main job, and those inparallel-commands-on-agentsbeing intelligently distributed across the 3 agents by Nx Cloud - Shut down all agents when all parallel tasks have been completed
.github/workflows/ci.yml
name: CI
on:
push:
branches:
- main
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
cancel-in-progress: true
jobs:
main:
name: Nx Cloud - Main Job
uses: nrwl/ci/.github/workflows/[email protected]
with:
parallel-commands: |
npx nx workspace-lint
npx nx format:check
parallel-commands-on-agents: |
npx nx affected --target=lint --parallel=3
npx nx affected --target=test --parallel=3 --ci --code-coverage
npx nx affected --target=build --parallel=3
agents:
name: Nx Cloud - Agents
uses: nrwl/ci/.github/workflows/[email protected]
with:
number-of-agents: 3The main and agent workflows both support passing NX_CLOUD_AUTH_TOKEN and NX_CLOUD_ACCESS_TOKEN from the parent workflow.
This is accomplished by adding secrets: inherit which gives access to the secrets of the parent.
These secrets are still kept encrypted and the main workflow will only use the NX_CLOUD_AUTH_TOKEN and NX_CLOUD_ACCESS_TOKEN
if those are defined.
.github/workflows/ci.yml
name: CI
on:
push:
branches:
- main
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
cancel-in-progress: true
jobs:
main:
name: Nx Cloud - Main Job
uses: nrwl/ci/.github/workflows/[email protected]
secrets: inherit
with:
...
agents:
name: Nx Cloud - Agents
uses: nrwl/ci/.github/workflows/[email protected]
secrets: inherit
with:
...- uses: nrwl/ci/.github/workflows/[email protected]
with:
# [OPTIONAL] The available number of agents used by the Nx Cloud to distribute tasks in parallel.
# By default, NxCloud tries to infer dynamically how many agents you have available. Some agents
# can have delayed start leading to incorrect count when distributing tasks.
#
# If you know exactly how many agents you have available, it is recommended to set this so we can more
# reliably distribute the tasks.
number-of-agents: 3
# [OPTIONAL] A multi-line string containing non-secret environment variables which need to be passed from the parent workflow
# to the reusable workflow. The variables are defined in form `VARIABLE_NAME=value`
#
# NOTE: Environment variables cannot contain values derived from ${{ secrets }}
# because of how reusable workflows work
environment-variables: |
""
# [OPTIONAL] A multi-line string representing any bash commands (separated by new lines) which should
# run sequentially, directly on the main job BEFORE executing any of the parallel commands which
# may be specified via parallel-commands and/or parallel-commands-on-agents
init-commands: |
""
# [OPTIONAL] A multi-line string representing any bash commands (separated by new lines) which should
# run in parallel, directly on the main job at the same time as any commands which may have beeen
# specified via parallel-commands-on-agents
#
# NOTE: Due to how each stringified command gets interpreted in order to parallelize it, there may be
# some limitations in terms of quote escaping and variable assignments within the command itself.
parallel-commands: |
""
# [OPTIONAL] A multi-line string representing any bash commands (separated by new lines) which should
# run in parallel, preferentially distributed across any available agents at the same time as any
# commands which may have been specified via parallel-commands
#
# NOTE: Due to how each stringified command gets interpreted in order to parallelize it, there may be
# some limitations in terms of quote escaping and variable assignments within the command itself.
parallel-commands-on-agents: |
""
# [OPTIONAL] A multi-line string representing any bash commands (separated by new lines) which should
# run sequentially, directly on the main job AFTER executing any of the parallel commands which
# may be specified via parallel-commands and/or parallel-commands-on-agents
final-commands: |
""
# [OPTIONAL] The "main" branch of your repository (the base branch which you target with PRs).
# Common names for this branch include main and master.
#
# Default: main
main-branch-name: ""
# [OPTIONAL] If you want to provide a specific node-version to use you can do that here.
# If you do not specify one, it will respect an optional volta config you might have in
# your package.json, otherwise it will simply install the latest LTS version of node.
node-version: ""
# [OPTIONAL] If you want to provide a specific npm-version to use you can do that here.
# If you do not specify one, it will respect an optional volta config you might have in
# your package.json, otherwise it will simply install the version of npm which is bundled
# with the latest LTS version of node.
npm-version: ""
# [OPTIONAL] If you want to provide a specific yarn v1 version to use you can do that here.
# If you do not specify one, it will respect an optional volta config you might have in
# your package.json, otherwise it will simply install the latest v1 version of yarn available.
yarn-version: ""
# [OPTIONAL] If you want to provide a specific pnpm version to use you can do that here.
# If you do not specify one, it will install the latest version of pnpm available.
# Pnpm gets installed only if pnpm-lock.yaml is present in your repo.
pnpm-version: ""
# [OPTIONAL] If you want to provide specific install commands to use when installing dependencies
# you can do that here. The default install step is not executed when this input is given.
install-commands: ""
# [OPTIONAL] Provides override for type of the machine to run the workflow on
# The machine can be either a GitHub-hosted runner or a self-hosted runner
#
# NOTE: If you change this option, make sure it matches the agent configuration
# Default: ubuntu-latest
runs-on: ""- uses: nrwl/ci/.github/workflows/[email protected]
with:
# [REQUIRED] The number of agents which should be created as part of the workflow in order to
# allow Nx Cloud to intelligently distribute tasks in parallel.
number-of-agents: 3
# [OPTIONAL] A multi-line string containing non-secret environment variables which need to be passed from the parent workflow
# to the reusable workflow. The variables are defined in form `VARIABLE_NAME=value`
#
# NOTE: Environment variables cannot contain values derived from ${{ secrets }}
# because of how reusable workflows work
environment-variables: |
""
# [OPTIONAL] If you want to provide a specific node-version to use you can do that here.
# If you do not specify one, it will respect an optional volta config you might have in
# your package.json, otherwise it will simply install the latest LTS version of node.
node-version: ""
# [OPTIONAL] If you want to provide a specific npm-version to use you can do that here.
# If you do not specify one, it will respect an optional volta config you might have in
# your package.json, otherwise it will simply install the version of npm which is bundled
# with the latest LTS version of node.
npm-version: ""
# [OPTIONAL] If you want to provide a specific yarn v1 version to use you can do that here.
# If you do not specify one, it will respect an optional volta config you might have in
# your package.json, otherwise it will simply install the latest v1 version of yarn available.
yarn-version: ""
# [OPTIONAL] If you want to provide a specific pnpm version to use you can do that here.
# If you do not specify one, it will install the latest version of pnpm available.
# Pnpm gets installed only if pnpm-lock.yaml is present in your repo.
pnpm-version: ""
# [OPTIONAL] If you want to provide specific install commands to use when installing dependencies
# you can do that here. The default install step is not executed when this input is given.
install-commands: ""
# [OPTIONAL] Provides override for type of the machine to run the workflow on
# The machine can be either a GitHub-hosted runner or a self-hosted runner
#
# NOTE: If you change this option, make sure it matches the main configuration
# Default: ubuntu-latest
runs-on: ""
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent