d4ebf82ac8
This PR adds Git filter `tree:0` to Azure and GitHub pipelines to avoid fetching the full history content because of the affected command. The change is made to: - `ci-workflow` generator in `workspace` project for Azure and GitHub - `ci-workflow` generator in `gradle` project for GitHub - this repo's main pipeline -`ci.yaml` - all documentation occurrences where fetch depth 0 is used on Azure or GitHub More info on reasoning here: https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/ ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
1.8 KiB
1.8 KiB
| title | description |
|---|---|
| Configuring CI Using GitHub Actions and Nx | Learn how to set up GitHub Actions for your Nx workspace using nx-set-shas to track successful builds, run affected commands, and optimize CI performance. |
Configuring CI Using GitHub Actions and Nx
Below is an example of a GitHub Actions setup, building, and testing only what is affected.
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
filter: tree: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 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.