From e4124c1c93d360bdd696d0c8166836965418d182 Mon Sep 17 00:00:00 2001 From: Jason Jean Date: Fri, 30 May 2025 21:25:57 -0400 Subject: [PATCH] docs(core): improve affected command description to define affected projects (#31404) ## Current Behavior `nx affected` documentation was unclear and did not state what affected projects actually meant. ## Expected Behavior Adds a clear definition of "affected projects" to the CLI documentation. Affected projects are projects that have been changed and projects that depend on the changed projects. ## Related Issue(s) Fixes #30712 --------- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> --- docs/generated/cli/affected.md | 4 ++-- docs/generated/packages/nx/documents/affected.md | 4 ++-- packages/nx/src/command-line/affected/command-object.ts | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md index e56a99d66a..a1f63cf7cf 100644 --- a/docs/generated/cli/affected.md +++ b/docs/generated/cli/affected.md @@ -1,11 +1,11 @@ --- title: 'affected - CLI command' -description: 'Run target for affected projects. See https://nx.dev/ci/features/affected for more details.' +description: 'Run target for affected projects. Affected projects are projects that have been changed and projects that depend on the changed projects. See https://nx.dev/ci/features/affected for more details.' --- # affected -Run target for affected projects. See [https://nx.dev/ci/features/affected](/ci/features/affected) for more details. +Run target for affected projects. Affected projects are projects that have been changed and projects that depend on the changed projects. See [https://nx.dev/ci/features/affected](/ci/features/affected) for more details. ## Usage diff --git a/docs/generated/packages/nx/documents/affected.md b/docs/generated/packages/nx/documents/affected.md index e56a99d66a..a1f63cf7cf 100644 --- a/docs/generated/packages/nx/documents/affected.md +++ b/docs/generated/packages/nx/documents/affected.md @@ -1,11 +1,11 @@ --- title: 'affected - CLI command' -description: 'Run target for affected projects. See https://nx.dev/ci/features/affected for more details.' +description: 'Run target for affected projects. Affected projects are projects that have been changed and projects that depend on the changed projects. See https://nx.dev/ci/features/affected for more details.' --- # affected -Run target for affected projects. See [https://nx.dev/ci/features/affected](/ci/features/affected) for more details. +Run target for affected projects. Affected projects are projects that have been changed and projects that depend on the changed projects. See [https://nx.dev/ci/features/affected](/ci/features/affected) for more details. ## Usage diff --git a/packages/nx/src/command-line/affected/command-object.ts b/packages/nx/src/command-line/affected/command-object.ts index 030b860a24..9b111c5ba8 100644 --- a/packages/nx/src/command-line/affected/command-object.ts +++ b/packages/nx/src/command-line/affected/command-object.ts @@ -15,7 +15,7 @@ import { export const yargsAffectedCommand: CommandModule = { command: 'affected', describe: - 'Run target for affected projects. See https://nx.dev/ci/features/affected for more details.', + 'Run target for affected projects. Affected projects are projects that have been changed and projects that depend on the changed projects. See https://nx.dev/ci/features/affected for more details.', builder: (yargs) => linkToNxDevAndExamples( withAffectedOptions(