@nx/docker 0.0.0-pr-31634-ece4eca → 0.0.0-pr-31634-e87d792

package/generators.json

@@ -3,7 +3,7 @@
   "version": "0.1",
   "generators": {
     "init": {
-      "factory": "./src/generators/init/init#initGeneratorInternal",
+      "factory": "./src/generators/init/init",
       "schema": "./src/generators/init/schema.json",
       "description": "Initialize the `@nx/docker` plugin. **Experimental**: Docker support is experimental. Breaking changes may occur and not adhere to semver versioning.",
       "aliases": ["ng-add"],

package/index.d.ts

@@ -1 +1,2 @@
 export { createNodesV2, DockerPluginOptions } from './src/plugins/plugin';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/docker/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nx/docker",
   "description": "The Nx Plugin for Docker to aid in containerizing projects.",
-  "version": "0.0.0-pr-31634-ece4eca",
+  "version": "0.0.0-pr-31634-e87d792",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -32,16 +32,23 @@
       "types": "./src/release/version-utils.d.ts",
       "default": "./src/release/version-utils.js"
     },
-    "./package.json": {
-      "default": "./package.json"
-    }
+    "./package.json": "./package.json",
+    "./generators.json": "./generators.json",
+    "./executors.json": "./executors.json",
+    "./migrations.json": "./migrations.json"
+  },
+  "nx-migrations": {
+    "migrations": "./migrations.json"
   },
   "executors": "./executors.json",
   "generators": "./generators.json",
   "dependencies": {
-    "@nx/devkit": "0.0.0-pr-31634-ece4eca",
+    "@nx/devkit": "0.0.0-pr-31634-e87d792",
     "enquirer": "~2.3.6",
     "tslib": "^2.3.0"
   },
-  "types": "./index.d.ts"
+  "devDependencies": {
+    "nx": "0.0.0-pr-31634-e87d792"
+  },
+  "types": "./src/index.d.ts"
 }

package/project.json

@@ -0,0 +1,52 @@
+{
+    "name": "docker",
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "packages/docker",
+    "projectType": "library",
+    "targets": {
+        "build": {
+            "command": "node ./scripts/copy-readme.js docker",
+            "outputs": ["{workspaceRoot}/build/packages/docker/README.md"]
+        },
+        "legacy-post-build": {
+            "executor": "@nx/workspace-plugin:legacy-post-build",
+            "options": {
+                "tsConfig": "./tsconfig.lib.json",
+                "assets": [
+                    {
+                        "input": "packages/docker",
+                        "glob": "**/files/**",
+                        "output": "/"
+                    },
+                    {
+                        "input": "packages/docker",
+                        "glob": "**files/**/.gitkeep",
+                        "output": "/"
+                    },
+                    {
+                        "input": "packages/docker",
+                        "glob": "**/*.json",
+                        "ignore": ["**/tsconfig*.json", "project.json", ".eslintrc.json"],
+                        "output": "/"
+                    },
+                    {
+                        "input": "packages/docker",
+                        "glob": "**/*.js",
+                        "ignore": ["**/jest.config.js"],
+                        "output": "/"
+                    },
+                    {
+                        "input": "packages/docker",
+                        "glob": "**/*.d.ts",
+                        "output": "/"
+                    },
+                    {
+                        "input": "",
+                        "glob": "LICENSE",
+                        "output": "/"
+                    }
+                ]
+            }
+        }
+    }
+}

package/src/executors/release-publish/release-publish.impl.d.ts

@@ -3,3 +3,4 @@ import { DockerReleasePublishSchema } from './schema';
 export default function dockerReleasePublish(schema: DockerReleasePublishSchema, context: ExecutorContext): Promise<{
     success: boolean;
 }>;
+//# sourceMappingURL=release-publish.impl.d.ts.map

package/src/executors/release-publish/release-publish.impl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-publish.impl.d.ts","sourceRoot":"","sources":["../../../../../../packages/docker/src/executors/release-publish/release-publish.impl.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAIhB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,0BAA0B,EAE3B,MAAM,UAAU,CAAC;AAIlB,wBAA8B,oBAAoB,CAChD,MAAM,EAAE,0BAA0B,EAClC,OAAO,EAAE,eAAe;;GAiBzB"}

package/src/executors/release-publish/release-publish.impl.js

@@ -3,14 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = dockerReleasePublish;
 const devkit_1 = require("@nx/devkit");
 const child_process_1 = require("child_process");
-const path_1 = require("path");
 const fs_1 = require("fs");
+const version_utils_1 = require("../../release/version-utils");
 async function dockerReleasePublish(schema, context) {
-    devkit_1.logger.warn(`Docker support is experimental. Breaking changes may occur and not adhere to semver versioning.`);
     const projectConfig = context.projectGraph.nodes[context.projectName];
     const options = normalizeOptions(projectConfig, schema);
     if (!options.dryRun) {
-        const digest = dockerPush(options.imageReference);
+        const digest = dockerPush(options.imageReference, options.quiet);
         devkit_1.logger.log(`Successfully pushed ${options.imageReference}. Digest: ${digest}`);
     }
     else {
@@ -22,6 +21,7 @@ async function dockerReleasePublish(schema, context) {
 }
 function normalizeOptions(projectConfig, schema) {
     return {
+        quiet: schema.quiet ?? false,
         imageReference: findImageReference(projectConfig, schema),
         dryRun: process.env.NX_DRY_RUN === 'true' || schema.dryRun || false,
     };
@@ -36,9 +36,9 @@ function findImageReference(projectConfig, schema) {
     }
 }
 function readVersionFromFile(projectRoot) {
-    const versionFilePath = (0, path_1.join)(projectRoot, '.docker-version');
+    const versionFilePath = (0, version_utils_1.getDockerVersionPath)(devkit_1.workspaceRoot, projectRoot);
     if (!(0, fs_1.existsSync)(versionFilePath)) {
-        throw new Error("Could not find .docker-version file. Did you run 'nx release version'?");
+        throw new Error(`Could not find ${versionFilePath} file. Did you run 'nx release version'?`);
     }
     const version = (0, fs_1.readFileSync)(versionFilePath, { encoding: 'utf8' });
     return version.trim();
@@ -52,9 +52,9 @@ function checkDockerImageExistsLocally(imageRef) {
         return false;
     }
 }
-function dockerPush(imageReference) {
+function dockerPush(imageReference, quiet) {
     try {
-        const result = (0, child_process_1.execSync)(`docker push ${imageReference} --quiet`, {
+        const result = (0, child_process_1.execSync)(`docker push ${imageReference}${quiet ? ' --quiet' : ''}`, {
             encoding: 'utf8',
         });
         return result.trim();

package/src/executors/release-publish/schema.d.ts

@@ -1,8 +1,10 @@
 export interface DockerReleasePublishSchema {
   dryRun?: boolean;
+  quiet?: boolean;
 }
 
 export interface NormalizedDockerReleasePublishSchema {
+  quiet: boolean;
   imageReference: string;
   dryRun: boolean;
 }

package/src/executors/release-publish/schema.json

@@ -8,6 +8,11 @@
     "dryRun": {
       "type": "boolean",
       "description": "Whether to run the command without actually publishing the image to the registry."
+    },
+    "quiet": {
+      "type": "boolean",
+      "description": "Suppress verbose output",
+      "default": false
     }
   },
   "required": []

package/src/generators/init/init.d.ts

@@ -2,5 +2,5 @@ import { type Tree, type GeneratorCallback } from '@nx/devkit';
 import { InitGeneratorSchema } from './schema';
 export declare function updateDependencies(tree: Tree, schema: InitGeneratorSchema): GeneratorCallback;
 export declare function initGenerator(tree: Tree, schema: InitGeneratorSchema): Promise<GeneratorCallback>;
-export declare function initGeneratorInternal(tree: Tree, schema: InitGeneratorSchema): Promise<GeneratorCallback>;
 export default initGenerator;
+//# sourceMappingURL=init.d.ts.map

package/src/generators/init/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../../../packages/docker/src/generators/init/init.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EACT,KAAK,iBAAiB,EAOvB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAI/C,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,qBAUzE;AAED,wBAAsB,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,8BA4B1E;AAED,eAAe,aAAa,CAAC"}

package/src/generators/init/init.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateDependencies = updateDependencies;
 exports.initGenerator = initGenerator;
-exports.initGeneratorInternal = initGeneratorInternal;
 const devkit_1 = require("@nx/devkit");
 const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
 const plugin_1 = require("../../plugins/plugin");
@@ -12,21 +11,13 @@ function updateDependencies(tree, schema) {
         '@nx/docker': versions_1.nxVersion,
     }, undefined, schema.keepExistingVersions);
 }
-function initGenerator(tree, schema) {
-    return initGeneratorInternal(tree, { addPlugin: false, ...schema });
-}
-async function initGeneratorInternal(tree, schema) {
+async function initGenerator(tree, schema) {
     devkit_1.logger.warn(`Docker support is experimental. Breaking changes may occur and not adhere to semver versioning.`);
     const nxJson = (0, devkit_1.readNxJson)(tree);
-    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
-        nxJson.useInferencePlugins !== false;
-    schema.addPlugin ??= addPluginDefault;
-    if (schema.addPlugin) {
-        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/docker', plugin_1.createNodesV2, {
-            buildTarget: ['docker:build', 'docker-build', 'build-docker'],
-            runTarget: ['docker:run', 'docker-run', 'run-docker'],
-        }, schema.updatePackageScripts);
-    }
+    await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/docker', plugin_1.createNodesV2, {
+        buildTarget: ['docker:build', 'docker-build', 'build-docker'],
+        runTarget: ['docker:run', 'docker-run', 'run-docker'],
+    }, schema.updatePackageScripts);
     const tasks = [];
     if (!schema.skipPackageJson) {
         tasks.push(updateDependencies(tree, schema));

package/src/plugins/plugin.d.ts

@@ -4,3 +4,4 @@ export interface DockerPluginOptions {
     runTarget?: string;
 }
 export declare const createNodesV2: CreateNodesV2<DockerPluginOptions>;
+//# sourceMappingURL=plugin.d.ts.map

package/src/plugins/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../../../packages/docker/src/plugins/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAOnB,MAAM,YAAY,CAAC;AAQpB,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAsBD,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,mBAAmB,CAkC5D,CAAC"}

package/src/plugins/plugin.js

@@ -14,25 +14,26 @@ function readTargetsCache(cachePath) {
 function writeTargetsCache(cachePath, results) {
     (0, devkit_1.writeJsonFile)(cachePath, results ?? {});
 }
-const dockerfileGlob = '**/Dockerfile';
+const dockerfileGlob = 'Dockerfile,**/Dockerfile';
 exports.createNodesV2 = [
     dockerfileGlob,
     async (configFilePaths, options, context) => {
         const optionsHash = (0, file_hasher_1.hashObject)(options);
         const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `docker-${optionsHash}.hash`);
         const targetsCache = readTargetsCache(cachePath);
+        const projectRoots = configFilePaths.map((c) => (0, path_1.dirname)(c));
+        const normalizedOptions = normalizePluginOptions(options);
+        const hashes = await (0, calculate_hash_for_create_nodes_1.calculateHashesForCreateNodes)(projectRoots, normalizedOptions, context);
         try {
-            return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => createNodesInternal(configFile, options, context, targetsCache), configFilePaths, options, context);
+            return await (0, devkit_1.createNodesFromFiles)((configFile, _, context, idx) => createNodesInternal(configFile, hashes[idx] + configFile, normalizedOptions, context, targetsCache), configFilePaths, options, context);
         }
         finally {
             writeTargetsCache(cachePath, targetsCache);
         }
     },
 ];
-async function createNodesInternal(configFilePath, options, context, targetsCache) {
+async function createNodesInternal(configFilePath, hash, normalizedOptions, context, targetsCache) {
     const projectRoot = (0, path_1.dirname)(configFilePath);
-    const normalizedOptions = normalizePluginOptions(options);
-    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, normalizedOptions, context);
     targetsCache[hash] ??= await createDockerTargets(projectRoot, normalizedOptions, context);
     const { targets, metadata } = targetsCache[hash];
     return {
@@ -65,7 +66,12 @@ async function createDockerTargets(projectRoot, options, context) {
             description: `Run Docker build`,
             help: {
                 command: `docker build --help`,
-                example: {},
+                example: {
+                    options: {
+                        'cache-from': 'type=s3,region=eu-west-1,bucket=mybucket .',
+                        'cache-to': 'type=s3,region=eu-west-1,bucket=mybucket .',
+                    },
+                },
             },
         },
     };
@@ -85,7 +91,11 @@ async function createDockerTargets(projectRoot, options, context) {
             description: `Run Docker run`,
             help: {
                 command: `docker run --help`,
-                example: {},
+                example: {
+                    options: {
+                        args: ['-p', '3000:3000'],
+                    },
+                },
             },
         },
     };

package/src/release/version-pattern-utils.d.ts

@@ -13,3 +13,4 @@ export interface PatternTokens {
     shortCommitSha: string;
 }
 export declare function interpolateVersionPattern(versionPattern: string, data: Partial<PatternTokens>): string;
+//# sourceMappingURL=version-pattern-utils.d.ts.map

package/src/release/version-pattern-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-pattern-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/docker/src/release/version-pattern-utils.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,IAAI,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;CACxB;AAsBD,wBAAgB,yBAAyB,CACvC,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,UA4B7B"}

package/src/release/version-utils.d.ts

@@ -1,6 +1,8 @@
-import { ProjectGraphProjectNode } from '@nx/devkit';
+import type { ProjectGraphProjectNode } from '@nx/devkit';
 import type { FinalConfigForProject } from 'nx/src/command-line/release/version/release-group-processor';
-export declare function handleDockerVersion(projectGraphNode: ProjectGraphProjectNode, finalConfigForProject: FinalConfigForProject): Promise<{
+export declare const getDockerVersionPath: (workspaceRoot: string, projectRoot: string) => string;
+export declare function handleDockerVersion(workspaceRoot: string, projectGraphNode: ProjectGraphProjectNode, finalConfigForProject: FinalConfigForProject, dockerVersionScheme?: string): Promise<{
     newVersion: string;
     logs: string[];
 }>;
+//# sourceMappingURL=version-utils.d.ts.map

package/src/release/version-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/docker/src/release/version-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,6DAA6D,CAAC;AAQzG,eAAO,MAAM,oBAAoB,GAC/B,eAAe,MAAM,EACrB,aAAa,MAAM,WAGpB,CAAC;AAEF,wBAAsB,mBAAmB,CACvC,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,uBAAuB,EACzC,qBAAqB,EAAE,qBAAqB,EAC5C,mBAAmB,CAAC,EAAE,MAAM;;;GA4B7B"}

package/src/release/version-utils.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDockerVersionPath = void 0;
 exports.handleDockerVersion = handleDockerVersion;
 const child_process_1 = require("child_process");
 const fs_1 = require("fs");
@@ -10,12 +11,18 @@ const DEFAULT_VERSION_SCHEMES = {
     production: '{currentDate|YYMM.DD}.{shortCommitSha}',
     hotfix: '{currentDate|YYMM.DD}.{shortCommitSha}-hotfix',
 };
-async function handleDockerVersion(projectGraphNode, finalConfigForProject) {
+const getDockerVersionPath = (workspaceRoot, projectRoot) => {
+    return (0, path_1.join)(workspaceRoot, 'tmp', projectRoot, '.docker-version');
+};
+exports.getDockerVersionPath = getDockerVersionPath;
+async function handleDockerVersion(workspaceRoot, projectGraphNode, finalConfigForProject, dockerVersionScheme) {
     const availableVersionSchemes = finalConfigForProject.dockerOptions.versionSchemes ??
         DEFAULT_VERSION_SCHEMES;
-    const versionScheme = await promptForNewVersion(availableVersionSchemes, projectGraphNode.name);
+    const versionScheme = dockerVersionScheme && dockerVersionScheme in availableVersionSchemes
+        ? dockerVersionScheme
+        : await promptForNewVersion(availableVersionSchemes, projectGraphNode.name);
     const newVersion = calculateNewVersion(projectGraphNode.name, versionScheme, availableVersionSchemes);
-    const logs = updateProjectVersion(newVersion, projectGraphNode.data.root, finalConfigForProject.dockerOptions.repositoryName, finalConfigForProject.dockerOptions.registryUrl);
+    const logs = updateProjectVersion(newVersion, workspaceRoot, projectGraphNode.data.root, finalConfigForProject.dockerOptions.repositoryName, finalConfigForProject.dockerOptions.registryUrl);
     return {
         newVersion,
         logs,
@@ -43,7 +50,7 @@ function calculateNewVersion(projectName, versionScheme, versionSchemes) {
         projectName,
     });
 }
-function updateProjectVersion(newVersion, projectRoot, repositoryName, registry) {
+function updateProjectVersion(newVersion, workspaceRoot, projectRoot, repositoryName, registry) {
     const isDryRun = process.env.NX_DRY_RUN && process.env.NX_DRY_RUN !== 'false';
     const imageRef = getDefaultImageReference(projectRoot);
     const newImageRef = getImageReference(projectRoot, repositoryName, registry);
@@ -56,7 +63,7 @@ function updateProjectVersion(newVersion, projectRoot, repositoryName, registry)
         logs.push(`No changes were applied as --dry-run is enabled.`);
     }
     else {
-        (0, fs_1.writeFileSync)((0, path_1.join)(projectRoot, '.docker-version'), fullImageRef);
+        (0, fs_1.writeFileSync)((0, exports.getDockerVersionPath)(workspaceRoot, projectRoot), fullImageRef);
     }
     return logs;
 }

package/src/utils/versions.d.ts

@@ -1 +1,2 @@
 export declare const nxVersion: any;
+//# sourceMappingURL=versions.d.ts.map

package/src/utils/versions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../../../../packages/docker/src/utils/versions.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,KAAwC,CAAC"}

package/src/utils/versions.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.nxVersion = void 0;
-exports.nxVersion = require('../../../package.json').version;
+exports.nxVersion = require('../../package.json').version;