feat(gradle): uncomment start-ci-run

nrwl · Jul 9, 2024 · acbb62e · acbb62e
1 parent 8fd38cb
commit acbb62e
Show file tree

Hide file tree

Showing 12 changed files with 183 additions and 79 deletions.
diff --git a/packages/gradle/src/generators/ci-workflow/__snapshots__/generator.spec.ts.snap b/packages/gradle/src/generators/ci-workflow/__snapshots__/generator.spec.ts.snap
@@ -17,8 +17,10 @@ jobs:
     steps:
       - checkout
 
+      # 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
       # Connect your workspace on nx.app and uncomment this to enable task distribution.
-      # The "--stop-agents-after" is optional, but allows idle agents to shut down once the "build" targets have been requested
       # - run: npx nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
 
       - nx/set-shas:
@@ -56,8 +58,10 @@ jobs:
         with:
           fetch-depth: 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
       # Connect your workspace on nx.app and uncomment this to enable task distribution.
-      # The "--stop-agents-after" is optional, but allows idle agents to shut down once the "build" targets have been requested
       # - run: npx nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
 
       - name: Set up JDK 17 for x64

diff --git a/packages/gradle/src/generators/ci-workflow/files/circleci/.circleci/config.yml.template b/packages/gradle/src/generators/ci-workflow/files/circleci/.circleci/config.yml.template
@@ -14,10 +14,13 @@ jobs:
     steps:
       - checkout
 
-      # Connect your workspace on <%= nxCloudHost %> and uncomment this to enable task distribution.
-      # The "--stop-agents-after" is optional, but allows idle agents to shut down once the "build" targets have been requested
+      # 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
+      <% if (connectedToCloud) { %>- run: <%= packageManagerPrefix %> nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
+      <% } else { %># Connect your workspace on nx.app and uncomment this to enable task distribution.
       # - run: <%= packageManagerPrefix %> nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
-
+      <% } %>
       - nx/set-shas:
           main-branch-name: '<%= mainBranch %>'
 

diff --git a/...c/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml.template b/...c/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml.template
@@ -18,9 +18,13 @@ jobs:
         with:
           fetch-depth: 0
 
-      # Connect your workspace on <%= nxCloudHost %> and uncomment this to enable task distribution.
-      # The "--stop-agents-after" is optional, but allows idle agents to shut down once the "build" targets have been requested
+      # 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
+      <% if (connectedToCloud) { %> - run: <%= packageManagerPrefix %> nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
+      <% } else { %># Connect your workspace on nx.app and uncomment this to enable task distribution.
       # - run: <%= packageManagerPrefix %> nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
+      <% } %>
 
       - name: Set up JDK 17 for x64
         uses: actions/setup-java@v4

diff --git a/packages/gradle/src/generators/ci-workflow/generator.ts b/packages/gradle/src/generators/ci-workflow/generator.ts
@@ -3,11 +3,9 @@ import {
   names,
   generateFiles,
   getPackageManagerCommand,
-  NxJsonConfiguration,
   formatFiles,
   detectPackageManager,
   readNxJson,
-  readJson,
 } from '@nx/devkit';
 import { join } from 'path';
 import { getNxCloudUrl, isNxCloudUsed } from 'nx/src/utils/nx-cloud-utils';
@@ -47,6 +45,7 @@ interface Substitutes {
   packageManagerPrefix: string;
   commands: string[];
   nxCloudHost: string;
+  connectedToCloud: boolean;
 }
 
 function getTemplateData(tree: Tree, options: Schema): Substitutes {
@@ -59,14 +58,16 @@ function getTemplateData(tree: Tree, options: Schema): Substitutes {
 
   let nxCloudHost: string = 'nx.app';
   try {
-    const nxCloudUrl = getNxCloudUrl(readJson(tree, 'nx.json'));
+    const nxCloudUrl = getNxCloudUrl(readNxJson(tree));
     nxCloudHost = new URL(nxCloudUrl).host;
   } catch {}
 
   const mainBranch = deduceDefaultBase();
 
   const commands = options.commands ?? getCiCommands(options.ci, mainBranch);
 
+  const connectedToCloud = isNxCloudUsed(readNxJson(tree));
+
   return {
     workflowName,
     workflowFileName,
@@ -75,6 +76,7 @@ function getTemplateData(tree: Tree, options: Schema): Substitutes {
     commands,
     mainBranch,
     nxCloudHost,
+    connectedToCloud,
   };
 }
 

diff --git a/packages/nx/src/utils/nx-cloud-utils.ts b/packages/nx/src/utils/nx-cloud-utils.ts
@@ -1,4 +1,4 @@
-import { NxJsonConfiguration, readNxJson } from '../config/nx-json';
+import { NxJsonConfiguration } from '../config/nx-json';
 
 export function isNxCloudUsed(nxJson: NxJsonConfiguration): boolean {
   return (