@nx/gradle 19.5.0-canary.20240712-0b0db78 → 19.5.0-canary.20240713-6f50d9f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/gradle",
-  "version": "19.5.0-canary.20240712-0b0db78",
+  "version": "19.5.0-canary.20240713-6f50d9f",
   "private": false,
   "description": "The Nx Plugin for Gradle allows Gradle tasks to be run through Nx",
   "repository": {
@@ -34,7 +34,7 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "19.5.0-canary.20240712-0b0db78"
+    "@nx/devkit": "19.5.0-canary.20240713-6f50d9f"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/ci-workflow/files/circleci/.circleci/config.yml.template

@@ -25,7 +25,7 @@ jobs:
           main-branch-name: '<%= mainBranch %>'
 
 <% for (const command of commands) { %>
-      - run: <%= command %><% } %>
+      <% if (command.command) { %>- run: <%= command.command %><% } else if (command.comment) { %><%= command.comment %><% } else {%>- run: <%= command %><% } %><% } %>
 
 workflows:
   version: 2

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

@@ -39,4 +39,4 @@ jobs:
       - uses: nrwl/nx-set-shas@v4
 
 <% for (const command of commands) { %>
-      - run: <%= command %><% } %>
+      <% if (command.command) { %>- run: <%= command.command %><% } else if (command.comment) { %><%= command.comment %><% } else {%>- run: <%= command %><% } %><% } %>

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

@@ -1,9 +1,14 @@
 import { Tree } from '@nx/devkit';
+export type Command = {
+    command: string;
+} | {
+    comment: string;
+} | string;
 export interface Schema {
     name: string;
     ci: 'github' | 'circleci';
     packageManager?: null;
-    commands?: string[];
+    commands?: Command[];
 }
 export declare function ciWorkflowGenerator(tree: Tree, schema: Schema): Promise<void>;
 export default ciWorkflowGenerator;

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

@@ -5,13 +5,25 @@ const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
 const nx_cloud_utils_1 = require("nx/src/utils/nx-cloud-utils");
 const default_base_1 = require("nx/src/utils/default-base");
-function getCiCommands(ci, mainBranch) {
+function getCiCommands(ci) {
     switch (ci) {
         case 'circleci': {
-            return [`./nx affected --base=$NX_BASE --head=$NX_HEAD -t test build`];
+            return [
+                {
+                    comment: `# Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
+                },
+                {
+                    command: `./nx affected --base=$NX_BASE --head=$NX_HEAD -t test build`,
+                },
+            ];
         }
         default: {
-            return [`./nx affected -t test build`];
+            return [
+                {
+                    comment: `# Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
+                },
+                { command: `./nx affected -t test build` },
+            ];
         }
     }
 }
@@ -32,7 +44,7 @@ function getTemplateData(tree, options) {
     }
     catch { }
     const mainBranch = (0, default_base_1.deduceDefaultBase)();
-    const commands = options.commands ?? getCiCommands(options.ci, mainBranch);
+    const commands = options.commands ?? getCiCommands(options.ci);
     const connectedToCloud = (0, nx_cloud_utils_1.isNxCloudUsed)((0, devkit_1.readNxJson)(tree));
     return {
         workflowName,

package/src/plugin/nodes.js

@@ -133,6 +133,14 @@ async function createGradleTargets(tasks, options, context, outputDirs, gradlePr
             dependsOn: dependsOnMap[task.name],
             metadata: {
                 technologies: ['gradle'],
+                help: {
+                    command: `${(0, exec_gradle_1.getGradleExecFile)()} help --task ${taskCommandToRun}`,
+                    example: {
+                        options: {
+                            args: ['--rerun'],
+                        },
+                    },
+                },
             },
             ...(outputs && outputs.length ? { outputs } : {}),
         };
@@ -175,6 +183,14 @@ function getTestCiTargets(testFiles, gradleProject, testTargetName, ciTargetName
             metadata: {
                 technologies: ['gradle'],
                 description: `Runs Gradle test ${testFile} in CI`,
+                help: {
+                    command: `${(0, exec_gradle_1.getGradleExecFile)()} help --task ${taskCommandToRun}`,
+                    example: {
+                        options: {
+                            args: ['--rerun'],
+                        },
+                    },
+                },
             },
             ...(outputs && outputs.length > 0 ? { outputs } : {}),
         };
@@ -195,6 +211,14 @@ function getTestCiTargets(testFiles, gradleProject, testTargetName, ciTargetName
             technologies: ['gradle'],
             description: 'Runs Gradle Tests in CI',
             nonAtomizedTarget: testTargetName,
+            help: {
+                command: `${(0, exec_gradle_1.getGradleExecFile)()} help --task ${taskCommandToRun}`,
+                example: {
+                    options: {
+                        args: ['--rerun'],
+                    },
+                },
+            },
         },
     };
     targetGroups[targetGroupName].push(ciTargetName);