miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(core): add filter for git checkouts in generated pipelines and docs (#30547)

Browse Source 
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 #
This commit is contained in:
Miroslav Jonaš 2025-04-10 11:33:31 +02:00 committed by GitHub
parent b82f29bd56
commit d4ebf82ac8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/nx-cloud/enterprise/dte/azure-dte.md
View File

@ -33,6 +33,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
persistCredentials: true
- script: npm ci

2
docs/nx-cloud/enterprise/dte/github-dte.md
View File

@ -40,6 +40,7 @@ jobs:
ref: ${{ github.event.pull_request.head.sha }}
# We need to fetch all branches and commits so that Nx affected has a base to compare against.
fetch-depth: 0
filter: tree:0
- uses: actions/checkout@v4
name: Checkout [Default Branch]
@ -47,6 +48,7 @@ jobs:
with:
# We need to fetch all branches and commits so that Nx affected has a base to compare against.
fetch-depth: 0
filter: tree:0
# Set node/npm/yarn versions using volta
- uses: volta-cli/action@v4

1
docs/nx-cloud/features/split-e2e-tasks.md
View File

@ -427,6 +427,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
- uses: pnpm/action-setup@v4
with:

2
docs/nx-cloud/tutorial/github-actions.md
View File

@ -72,6 +72,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
- uses: pnpm/action-setup@v4
with:
@ -207,6 +208,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
- uses: pnpm/action-setup@v4
with:

1
docs/shared/features/distribute-task-execution.md
View File

@ -54,6 +54,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
- run: pnpm dlx nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="build"

2
docs/shared/migration/adding-to-existing-project.md
View File

@ -354,6 +354,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun

2
docs/shared/migration/adding-to-monorepo.md
View File

@ -373,6 +373,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun

2
docs/shared/migration/migration-angular.md
View File

@ -176,6 +176,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun

1
docs/shared/monorepo-ci-azure.md
View File

@ -33,6 +33,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
persistCredentials: true
# Set Azure Devops CLI default settings

2
docs/shared/monorepo-ci-github-actions.md
View File

@ -28,6 +28,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
- uses: actions/setup-node@v3
with:
node-version: 20

1
docs/shared/recipes/nx-release/publish-in-ci-cd.md
View File

@ -134,6 +134,7 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
- name: Install Node
uses: actions/setup-node@v4

2
docs/shared/tutorials/angular-monorepo.md
View File

@ -1289,6 +1289,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun

1
docs/shared/tutorials/gradle.md
View File

@ -367,6 +367,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed

1
docs/shared/tutorials/react-monorepo.md
View File

@ -1124,6 +1124,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed

2
docs/shared/tutorials/typescript-packages.md
View File

@ -453,6 +453,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun

2
packages/gradle/src/generators/ci-workflow/__snapshots__/generator.spec.ts.snap
View File

@ -58,6 +58,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed
@ -140,6 +141,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed

1
packages/gradle/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml.template vendored
View File

@ -17,6 +17,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
filter: tree:0
# This enables task distribution via Nx Cloud
# Run this command as early as possible, before dependencies are installed

30
packages/workspace/src/generators/ci-workflow/__snapshots__/ci-workflow.spec.ts.snap
View File

@ -26,6 +26,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -170,6 +171,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -215,6 +217,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -267,6 +270,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -416,6 +420,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: oven-sh/setup-bun@v1
@ -457,6 +462,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: oven-sh/setup-bun@v1
@ -536,6 +542,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -674,6 +681,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -717,6 +725,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -796,6 +805,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -945,6 +955,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: pnpm/action-setup@v4
@ -992,6 +1003,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: pnpm/action-setup@v4
@ -1077,6 +1089,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -1215,6 +1228,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -1258,6 +1272,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -1337,6 +1352,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -1482,6 +1498,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -1527,6 +1544,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -1579,6 +1597,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -1729,6 +1748,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: oven-sh/setup-bun@v1
@ -1770,6 +1790,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: oven-sh/setup-bun@v1
@ -1849,6 +1870,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -1988,6 +2010,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -2031,6 +2054,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -2110,6 +2134,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -2260,6 +2285,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: pnpm/action-setup@v4
@ -2307,6 +2333,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
- uses: pnpm/action-setup@v4
@ -2392,6 +2419,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'
@ -2531,6 +2559,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -2574,6 +2603,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud

2
packages/workspace/src/generators/ci-workflow/ci-workflow.spec.ts
View File

@ -334,6 +334,7 @@ describe('CI Workflow generator', () => {
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
# This enables task distribution via Nx Cloud
@ -429,6 +430,7 @@ describe('CI Workflow generator', () => {
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'

1
packages/workspace/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__
View File

@ -23,6 +23,7 @@ jobs:
steps:
- checkout: self
fetchDepth: 0
fetchFilter: tree:0
# Set Azure Devops CLI default settings
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
displayName: 'Set default Azure DevOps organization and project'

2
packages/workspace/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml__tmpl__ vendored
View File

@ -16,7 +16,9 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
filter: tree:0
fetch-depth: 0
<% if(packageManager == 'pnpm'){ %>
- uses: pnpm/action-setup@v4
with: