@nx/workspace 21.3.0-beta.2 → 21.3.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/workspace",
-  "version": "21.3.0-beta.2",
+  "version": "21.3.0-beta.3",
   "private": false,
   "description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.",
   "repository": {
@@ -38,14 +38,14 @@
     }
   },
   "dependencies": {
-    "@nx/devkit": "21.3.0-beta.2",
+    "@nx/devkit": "21.3.0-beta.3",
     "@zkochan/js-yaml": "0.0.7",
     "chalk": "^4.1.0",
     "enquirer": "~2.3.6",
     "picomatch": "4.0.2",
     "tslib": "^2.3.0",
     "yargs-parser": "21.1.1",
-    "nx": "21.3.0-beta.2"
+    "nx": "21.3.0-beta.3"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/ci-workflow/ci-workflow.d.ts

@@ -1,6 +1,11 @@
 import { Tree } from '@nx/devkit';
+export type Command = {
+    command?: string;
+    comments?: string[];
+};
 export interface Schema {
     name: string;
     ci: 'github' | 'azure' | 'circleci' | 'bitbucket-pipelines' | 'gitlab';
+    useRunMany?: boolean;
 }
 export declare function ciWorkflowGenerator(tree: Tree, schema: Schema): Promise<void>;

package/src/generators/ci-workflow/ci-workflow.js

@@ -6,6 +6,97 @@ const default_base_1 = require("../../utilities/default-base");
 const path_1 = require("path");
 const nx_cloud_utils_1 = require("nx/src/utils/nx-cloud-utils");
 const ts_solution_setup_1 = require("../../utilities/typescript/ts-solution-setup");
+function getCiCommands(ci, packageManagerPrefix, mainBranch, hasTypecheck, hasE2E, useRunMany = false) {
+    // Build task list
+    const tasks = `lint test build${hasTypecheck ? ' typecheck' : ''}${hasE2E ? ' e2e' : ''}`;
+    // Create nx-cloud record example comment with CI-specific prefix
+    const baseCommand = `${packageManagerPrefix} nx-cloud record -- echo Hello World`;
+    const prefix = getCiPrefix(ci);
+    const exampleComment = `${prefix}${baseCommand}`;
+    // Build nx-cloud record comments
+    const nxCloudComments = [
+        `Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud`,
+        exampleComment,
+    ];
+    // Build nx command comments and command
+    const commandType = useRunMany ? 'run-many' : 'affected';
+    const nxCommandComments = useRunMany
+        ? [
+            `As your workspace grows, you can change this to use Nx Affected to run only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
+        ]
+        : [
+            `Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
+        ];
+    if (hasE2E) {
+        nxCommandComments.push(`When you enable task distribution, run the e2e-ci task instead of e2e`);
+    }
+    // Build nx command with CI-specific args
+    const args = getCiArgs(ci, mainBranch, useRunMany);
+    const nxCommand = `${packageManagerPrefix} nx ${commandType} ${args}-t ${tasks}`;
+    return [
+        {
+            comments: nxCloudComments,
+        },
+        {
+            comments: nxCommandComments,
+            command: nxCommand,
+        },
+    ];
+}
+function getCiPrefix(ci) {
+    if (ci === 'github' || ci === 'circleci') {
+        return '- run: ';
+    }
+    else if (ci === 'azure') {
+        return '- script: ';
+    }
+    else if (ci === 'gitlab') {
+        return '- ';
+    }
+    // Bitbucket expects just the command without prefix for pull requests
+    return '';
+}
+function getCiArgs(ci, mainBranch, useRunMany = false) {
+    // When using run-many, we don't need base/head SHA args
+    if (useRunMany) {
+        return '';
+    }
+    if (ci === 'azure') {
+        return '--base=$(BASE_SHA) --head=$(HEAD_SHA) ';
+    }
+    else if (ci === 'bitbucket-pipelines') {
+        return `--base=origin/${mainBranch} `;
+    }
+    return '';
+}
+function getBitbucketBranchCommands(packageManagerPrefix, hasTypecheck, hasE2E, useRunMany = false) {
+    const tasks = `lint test build${hasTypecheck ? ' typecheck' : ''}${hasE2E ? ' e2e-ci' : ''}`;
+    const nxCloudComments = [
+        `Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud`,
+        `- ${packageManagerPrefix} nx-cloud record -- echo Hello World`,
+    ];
+    // Build nx command comments and command
+    const commandType = useRunMany ? 'run-many' : 'affected';
+    const nxCommandComments = useRunMany
+        ? [
+            `As your workspace grows, you can change this to use Nx Affected to run only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
+        ]
+        : [
+            `Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
+        ];
+    // Build command with conditional base arg
+    const baseArg = useRunMany ? '' : ' --base=HEAD~1';
+    const command = `${packageManagerPrefix} nx ${commandType} -t ${tasks}${baseArg}`;
+    return [
+        {
+            comments: nxCloudComments,
+        },
+        {
+            comments: nxCommandComments,
+            command,
+        },
+    ];
+}
 async function ciWorkflowGenerator(tree, schema) {
     const ci = schema.ci;
     const options = normalizeOptions(schema, tree);
@@ -38,6 +129,11 @@ function normalizeOptions(options, tree) {
     const hasE2E = hasCypress || hasPlaywright;
     const hasTypecheck = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
     const connectedToCloud = (0, nx_cloud_utils_1.isNxCloudUsed)((0, devkit_1.readJson)(tree, 'nx.json'));
+    const mainBranch = (0, default_base_1.deduceDefaultBase)();
+    const commands = getCiCommands(options.ci, packageManagerPrefix, mainBranch, hasTypecheck, hasE2E, options.useRunMany ?? false);
+    const branchCommands = options.ci === 'bitbucket-pipelines'
+        ? getBitbucketBranchCommands(packageManagerPrefix, hasTypecheck, hasE2E, options.useRunMany ?? false)
+        : undefined;
     return {
         workflowName,
         workflowFileName,
@@ -45,7 +141,7 @@ function normalizeOptions(options, tree) {
         packageManagerInstall,
         packageManagerPrefix,
         packageManagerPreInstallPrefix,
-        mainBranch: (0, default_base_1.deduceDefaultBase)(),
+        mainBranch,
         packageManagerVersion: packageJson?.packageManager?.split('@')[1],
         hasCypress,
         hasE2E,
@@ -54,6 +150,9 @@ function normalizeOptions(options, tree) {
         nxCloudHost,
         tmpl: '',
         connectedToCloud,
+        useRunMany: options.useRunMany ?? false,
+        commands,
+        branchCommands,
     };
 }
 function defaultBranchNeedsOriginPrefix(nxJson) {

package/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__

@@ -8,13 +8,13 @@ pr:
 variables:
   CI: 'true'
   ${{ if eq(variables['Build.Reason'], 'PullRequest') }}:
-    NX_BRANCH: $(System.PullRequest.PullRequestNumber)
+    NX_BRANCH: $(System.PullRequest.PullRequestNumber)<% if(!useRunMany){ %>
     TARGET_BRANCH: $[replace(variables['System.PullRequest.TargetBranch'],'refs/heads/','origin/')]
-    BASE_SHA: $(git merge-base $(TARGET_BRANCH) HEAD)
+    BASE_SHA: $(git merge-base $(TARGET_BRANCH) HEAD)<% } %>
   ${{ if ne(variables['Build.Reason'], 'PullRequest') }}:
-    NX_BRANCH: $(Build.SourceBranchName)
+    NX_BRANCH: $(Build.SourceBranchName)<% if(!useRunMany){ %>
     BASE_SHA: $(git rev-parse HEAD~1)
-  HEAD_SHA: $(git rev-parse HEAD)
+  HEAD_SHA: $(git rev-parse HEAD)<% } %>
 
 jobs:
   - job: main
@@ -23,7 +23,7 @@ jobs:
     steps:
       - checkout: self
         fetchDepth: 0
-        fetchFilter: tree:0
+        fetchFilter: tree:0<% if(!useRunMany){ %>
       # 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'
@@ -40,7 +40,7 @@ jobs:
         displayName: 'Get last successful commit SHA'
         condition: ne(variables['Build.Reason'], 'PullRequest')
         env:
-          AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)
+          AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)<% } %>
 
       <% if(packageManager == 'pnpm'){ %>
       - script: npm install --prefix=$HOME/.local -g pnpm@8
@@ -61,12 +61,10 @@ jobs:
 
       - script: <%= packageManagerInstall %><% if(hasCypress){ %>
       - script: <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
-      - script: <%= packageManagerPrefix %> playwright install --with-deps<% } %>
+      - script: <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
       - script: git branch --track <%= mainBranch %> origin/<%= mainBranch %>
-        condition: eq(variables['Build.Reason'], 'PullRequest')
+        condition: eq(variables['Build.Reason'], 'PullRequest')<% } %>
 
-      # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
-      # - script: <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
-      # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected<% if(hasE2E){ %>
-      # When you enable task distribution, run the e2e-ci task instead of e2e<% } %>
-      - script: <%= packageManagerPrefix %> nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
+<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
+      # <%- comment %><% } %><% } %><% if (command.command) { %>
+      - script: <%= command.command %><% } %><% } %>

package/src/generators/ci-workflow/files/bitbucket-pipelines/bitbucket-pipelines.yml__tmpl__

@@ -29,11 +29,9 @@ pipelines:
             - <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
             - <%= packageManagerPrefix %> playwright install --with-deps<% } %>
 
-            # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
-            # <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
-            # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected<% if(hasE2E){ %>
-            # When you enable task distribution, run the e2e-ci task instead of e2e<% } %>
-            - <%= packageManagerPrefix %> nx affected --base=origin/<%= mainBranch %> -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
+<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
+            # <%- comment %><% } %><% } %><% if (command.command) { %>
+            - <%= command.command %><% } %><% } %>
 
   branches:
     main:
@@ -56,7 +54,6 @@ pipelines:
             <% } %>
             - <%= packageManagerInstall %>
 
-            # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
-            # - <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
-            # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
-            - <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e-ci<% } %> --base=HEAD~1
+<% for (const command of branchCommands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
+            # <%- comment %><% } %><% } %><% if (command.command) { %>
+            - <%= command.command %><% } %><% } %>

package/src/generators/ci-workflow/files/circleci/.circleci/config.yml__tmpl__

@@ -29,15 +29,13 @@ jobs:
 
       - run: <%= packageManagerInstall %><% if(hasCypress){ %>
       - run: <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
-      - run: <%= packageManagerPrefix %> playwright install --with-deps<% } %>
+      - run: <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
       - nx/set-shas:
-          main-branch-name: '<%= mainBranch %>'
+          main-branch-name: '<%= mainBranch %>'<% } %>
 
-      # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
-      # - run: <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
-      # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected<% if(hasE2E){ %>
-      # When you enable task distribution, run the e2e-ci task instead of e2e<% } %>
-      - run: <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
+<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
+      # <%- comment %><% } %><% } %><% if (command.command) { %>
+      - run: <%= command.command %><% } %><% } %>
 
 workflows:
   version: 2

package/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml__tmpl__

@@ -47,11 +47,9 @@ jobs:
        <% } %>
       - run: <%= packageManagerInstall %><% if(hasCypress){ %>
       - run: <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
-      - run: <%= packageManagerPrefix %> playwright install --with-deps<% } %>
-      - uses: nrwl/nx-set-shas@v4
+      - run: <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
+      - uses: nrwl/nx-set-shas@v4<% } %>
 
-      # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
-      # - run: <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
-      # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected<% if(hasE2E){ %>
-      # When you enable task distribution, run the e2e-ci task instead of e2e<% } %>
-      - run: <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
+<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
+      # <%- comment %><% } %><% } %><% if (command.command) { %>
+      - run: <%= command.command %><% } %><% } %>

package/src/generators/ci-workflow/files/gitlab/.gitlab-ci.yml__tmpl__

@@ -23,12 +23,10 @@ variables:
 
     - <%= packageManagerInstall %><% if(hasCypress){ %>
     - <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
-    - <%= packageManagerPrefix %> playwright install --with-deps<% } %>
+    - <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
     - NX_HEAD=$CI_COMMIT_SHA
-    - NX_BASE=${CI_MERGE_REQUEST_DIFF_BASE_SHA:-$CI_COMMIT_BEFORE_SHA}
+    - NX_BASE=${CI_MERGE_REQUEST_DIFF_BASE_SHA:-$CI_COMMIT_BEFORE_SHA}<% } %>
 
-    # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
-    # - <%= packageManagerPrefix %> nx-cloud record -- echo Hello World
-    # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected<% if(hasE2E){ %>
-    # When you enable task distribution, run the e2e-ci task instead of e2e<% } %>
-    - <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
+<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
+    # <%- comment %><% } %><% } %><% if (command.command) { %>
+    - <%= command.command %><% } %><% } %>

package/src/generators/ci-workflow/schema.json

@@ -32,6 +32,12 @@
       "default": "CI",
       "x-prompt": "How should we name your workflow?",
       "pattern": "^[a-zA-Z].*$"
+    },
+    "useRunMany": {
+      "type": "boolean",
+      "description": "Use 'nx run-many' instead of 'nx affected' in the generated CI workflow.",
+      "default": false,
+      "hidden": true
     }
   },
   "required": ["ci", "name"]