@nx/gradle 19.5.0-beta.0 → 19.5.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/gradle",
-  "version": "19.5.0-beta.0",
+  "version": "19.5.0-beta.2",
   "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-beta.0"
+    "@nx/devkit": "19.5.0-beta.2"
   },
   "publishConfig": {
     "access": "public"

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

@@ -14,15 +14,18 @@ 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 by running "nx connect" and uncomment this
       # - run: <%= packageManagerPrefix %> nx-cloud start-ci-run --distribute-on="5 linux-medium-jvm" --stop-agents-after="build"
-
+      <% } %>
       - nx/set-shas:
           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

@@ -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 by running "nx connect" and uncomment this
       # - 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
@@ -35,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

@@ -1,17 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ciWorkflowGenerator = void 0;
+exports.ciWorkflowGenerator = ciWorkflowGenerator;
 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` },
+            ];
         }
     }
 }
@@ -21,19 +33,19 @@ async function ciWorkflowGenerator(tree, schema) {
     (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, 'files', ci), '', options);
     await (0, devkit_1.formatFiles)(tree);
 }
-exports.ciWorkflowGenerator = ciWorkflowGenerator;
 function getTemplateData(tree, options) {
     const { name: workflowName, fileName: workflowFileName } = (0, devkit_1.names)(options.name);
     const packageManager = (0, devkit_1.detectPackageManager)();
     const { exec: packageManagerPrefix } = (0, devkit_1.getPackageManagerCommand)(packageManager);
     let nxCloudHost = 'nx.app';
     try {
-        const nxCloudUrl = (0, nx_cloud_utils_1.getNxCloudUrl)((0, devkit_1.readJson)(tree, 'nx.json'));
+        const nxCloudUrl = (0, nx_cloud_utils_1.getNxCloudUrl)((0, devkit_1.readNxJson)(tree));
         nxCloudHost = new URL(nxCloudUrl).host;
     }
     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,
         workflowFileName,
@@ -42,6 +54,7 @@ function getTemplateData(tree, options) {
         commands,
         mainBranch,
         nxCloudHost,
+        connectedToCloud,
     };
 }
 exports.default = ciWorkflowGenerator;

package/src/generators/init/init.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateNxJsonConfiguration = exports.addBuildGradleFileNextToSettingsGradle = exports.initGenerator = void 0;
+exports.initGenerator = initGenerator;
+exports.addBuildGradleFileNextToSettingsGradle = addBuildGradleFileNextToSettingsGradle;
+exports.updateNxJsonConfiguration = updateNxJsonConfiguration;
 const devkit_1 = require("@nx/devkit");
 const child_process_1 = require("child_process");
 const versions_1 = require("../../utils/versions");
@@ -27,7 +29,6 @@ Running 'gradle init':`);
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
-exports.initGenerator = initGenerator;
 function addPlugin(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     if (!(0, has_gradle_plugin_1.hasGradlePlugin)(tree)) {
@@ -54,7 +55,6 @@ async function addBuildGradleFileNextToSettingsGradle(tree) {
         addProjectReportToBuildGradle(settingsGradleFile, tree);
     });
 }
-exports.addBuildGradleFileNextToSettingsGradle = addBuildGradleFileNextToSettingsGradle;
 /**
  * - creates a build.gradle file next to the settings.gradle file if it does not exist.
  * - adds the project-report plugin to the build.gradle file if it does not exist.
@@ -134,5 +134,4 @@ function updateNxJsonConfiguration(tree) {
     nxJson.namedInputs.production = Array.from(new Set([...productionFileSet, 'default', '!{projectRoot}/src/test/**/*']));
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-exports.updateNxJsonConfiguration = updateNxJsonConfiguration;
 exports.default = initGenerator;

package/src/migrations/19-4-0/add-project-report-all.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
 const init_1 = require("../../generators/init/init");
 /**
  * This migration adds task `projectReportAll` to build.gradle files
@@ -7,4 +8,3 @@ const init_1 = require("../../generators/init/init");
 async function update(tree) {
     await (0, init_1.addBuildGradleFileNextToSettingsGradle)(tree);
 }
-exports.default = update;

package/src/migrations/19-4-1/change-regex-test-production.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
 const devkit_1 = require("@nx/devkit");
 const has_gradle_plugin_1 = require("../../utils/has-gradle-plugin");
 // This function changes !{projectRoot}/test/**/* in nx.json for production to !{projectRoot}/src/test/**/*
@@ -18,4 +19,3 @@ function update(tree) {
         (0, devkit_1.updateNxJson)(tree, nxJson);
     }
 }
-exports.default = update;

package/src/plugin/dependencies.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processGradleDependencies = exports.createDependencies = void 0;
+exports.createDependencies = void 0;
+exports.processGradleDependencies = processGradleDependencies;
 const devkit_1 = require("@nx/devkit");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
@@ -79,4 +80,3 @@ function processGradleDependencies(depsFile, gradleProjectToProjectName, sourceP
         }
     }
 }
-exports.processGradleDependencies = processGradleDependencies;

package/src/plugin/nodes.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = exports.makeCreateNodesForGradleConfigFile = exports.createNodesV2 = exports.writeTargetsToCache = void 0;
+exports.createNodes = exports.makeCreateNodesForGradleConfigFile = exports.createNodesV2 = void 0;
+exports.writeTargetsToCache = writeTargetsToCache;
 const devkit_1 = require("@nx/devkit");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
 const node_fs_1 = require("node:fs");
@@ -29,7 +30,6 @@ function readTargetsCache(cachePath) {
 function writeTargetsToCache(cachePath, results) {
     (0, devkit_1.writeJsonFile)(cachePath, results);
 }
-exports.writeTargetsToCache = writeTargetsToCache;
 exports.createNodesV2 = [
     get_gradle_report_1.gradleConfigAndTestGlob,
     async (files, options, context) => {
@@ -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);

package/src/utils/exec-gradle.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { ExecFileOptions } from 'node:child_process';
 export declare function getGradleBinaryPath(): string;
 export declare function getGradleExecFile(): string;

package/src/utils/exec-gradle.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.execGradleAsync = exports.getGradleExecFile = exports.getGradleBinaryPath = void 0;
+exports.getGradleBinaryPath = getGradleBinaryPath;
+exports.getGradleExecFile = getGradleExecFile;
+exports.execGradleAsync = execGradleAsync;
 const devkit_1 = require("@nx/devkit");
 const node_child_process_1 = require("node:child_process");
 const node_fs_1 = require("node:fs");
@@ -15,11 +17,9 @@ function getGradleBinaryPath() {
     }
     return gradleBinaryPath;
 }
-exports.getGradleBinaryPath = getGradleBinaryPath;
 function getGradleExecFile() {
     return process.platform.startsWith('win') ? '.\\gradlew.bat' : './gradlew';
 }
-exports.getGradleExecFile = getGradleExecFile;
 function execGradleAsync(args, execOptions = {}) {
     const gradleBinaryPath = getGradleBinaryPath();
     return new Promise((res, rej) => {
@@ -43,4 +43,3 @@ function execGradleAsync(args, execOptions = {}) {
         });
     });
 }
-exports.execGradleAsync = execGradleAsync;

package/src/utils/get-gradle-report.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processProjectReports = exports.populateGradleReport = exports.getCurrentGradleReport = exports.gradleConfigAndTestGlob = exports.gradleConfigGlob = exports.GRADLE_TEST_FILES = exports.GRADLE_BUILD_FILES = exports.newLineSeparator = exports.fileSeparator = void 0;
+exports.gradleConfigAndTestGlob = exports.gradleConfigGlob = exports.GRADLE_TEST_FILES = exports.GRADLE_BUILD_FILES = exports.newLineSeparator = exports.fileSeparator = void 0;
+exports.getCurrentGradleReport = getCurrentGradleReport;
+exports.populateGradleReport = populateGradleReport;
+exports.processProjectReports = processProjectReports;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const devkit_1 = require("@nx/devkit");
@@ -28,7 +31,6 @@ function getCurrentGradleReport() {
     }
     return gradleReportCache;
 }
-exports.getCurrentGradleReport = getCurrentGradleReport;
 async function populateGradleReport(workspaceRoot) {
     const gradleConfigHash = await (0, workspace_context_1.hashWithWorkspaceContext)(workspaceRoot, [
         exports.gradleConfigGlob,
@@ -67,7 +69,6 @@ async function populateGradleReport(workspaceRoot) {
     performance.measure('gradleProjectReport', gradleProjectReportStart.name, gradleProjectReportEnd.name);
     gradleReportCache = processProjectReports(projectReportLines);
 }
-exports.populateGradleReport = populateGradleReport;
 function processProjectReports(projectReportLines) {
     /**
      * Map of Gradle File path to Gradle Project Name
@@ -181,4 +182,3 @@ function processProjectReports(projectReportLines) {
         gradleProjectToProjectName,
     };
 }
-exports.processProjectReports = processProjectReports;

package/src/utils/has-gradle-plugin.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasGradlePlugin = void 0;
+exports.hasGradlePlugin = hasGradlePlugin;
 const devkit_1 = require("@nx/devkit");
 function hasGradlePlugin(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     return !!nxJson.plugins?.some((p) => typeof p === 'string' ? p === '@nx/gradle' : p.plugin === '@nx/gradle');
 }
-exports.hasGradlePlugin = hasGradlePlugin;