f08cd4cae3
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> This was changed in the generated ci workflow but not on the docs. ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> This is changed in the docs as well so it's not confusing. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
# Configuring CI Using GitHub Actions and Nx
|
|
|
|
Below is an example of a GitHub Actions setup, building, and testing only what is affected.
|
|
|
|
```yaml {% fileName=".github/workflows/ci.yml" %}
|
|
name: CI
|
|
on:
|
|
push:
|
|
branches:
|
|
# Change this if your primary branch is not main
|
|
- main
|
|
pull_request:
|
|
|
|
# Needed for nx-set-shas when run on the main branch
|
|
permissions:
|
|
actions: read
|
|
contents: read
|
|
|
|
jobs:
|
|
main:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- uses: actions/setup-node@v3
|
|
with:
|
|
node-version: 20
|
|
cache: 'npm'
|
|
# This line enables distribution
|
|
# The "--stop-agents-after" is optional, but allows idle agents to shut down once the "e2e-ci" targets have been requested
|
|
# - run: npx nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="e2e-ci"
|
|
- run: npm ci
|
|
|
|
- uses: nrwl/nx-set-shas@v4
|
|
|
|
- run: npx nx-cloud record -- nx format:check
|
|
- run: npx nx affected -t lint test build e2e-ci
|
|
```
|
|
|
|
### Get the Commit of the Last Successful Build
|
|
|
|
The `GitHub` can track the last successful run on the `main` branch and use this as a reference point for the `BASE`. The [nrwl/nx-set-shas](https://github.com/marketplace/actions/nx-set-shas) provides a convenient implementation of this functionality, which you can drop into your existing CI workflow.
|
|
|
|
To understand why knowing the last successful build is important for the affected command, check out the [in-depth explanation in Actions's docs](https://github.com/marketplace/actions/nx-set-shas#background).
|