@vamship/build-utils 2.2.2 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vamship/build-utils",
-    "version": "2.2.2",
+    "version": "2.4.0",
     "description": "Utility library for build tooling",
     "type": "module",
     "main": "src/index.js",

package/src/project.js

@@ -88,12 +88,15 @@ export class Project {
 
         this._containerTargets = Object.keys(this._container).reduce(
             (result, key) => {
-                const { repo, buildFile, buildArgs } = this._container[key];
+                const { repo, buildFile, buildArgs, buildSecrets } =
+                    this._container[key];
+
                 result[key] = {
                     name: key,
                     repo,
-                    buildFile,
-                    buildArgs,
+                    buildFile: buildFile || 'Dockerfile',
+                    buildArgs: buildArgs || {},
+                    buildSecrets: buildSecrets || {},
                 };
                 return result;
             },
@@ -276,11 +279,7 @@ export class Project {
     }
 
     /**
-     * Returns a list of docker targets defined for the project. Every target
-     * will define the following properties:
-     * - repo: The docker repo
-     * - buildFile: The name of the build file to use
-     * - buildArgs: Arguments to be passed to the docker build
+     * Returns a list of docker targets defined for the project.
      *
      * @return {Array}
      */
@@ -289,9 +288,14 @@ export class Project {
     }
 
     /**
-     * Gets CDK stack information based on the cdk stack key.
+     * Gets the definition for a specific container target. The definition will
+     * include the following properties:
+     * - repo: The docker repo
+     * - buildFile: The name of the build file to use
+     * - buildArgs: Arguments to be passed to the docker build
+     * - buildSecrets: Secrets to be passed to the docker build
      *
-     * @param {String} target The CDK target name
+     * @param {String} target The container target name
      * @returns {Object} The container definition corresponding to the target.
      */
     getContainerDefinition(target) {

package/src/schema/project-definition.js

@@ -109,6 +109,35 @@ export default {
                                     },
                                     additionalProperties: false,
                                 },
+
+                                /**
+                                 * Collection of secrets passed to the
+                                 * container build.
+                                 */
+                                buildSecrets: {
+                                    type: 'object',
+                                    /**
+                                     * Individual build arguments
+                                     */
+                                    patternProperties: {
+                                        '^[a-zA-Z0-9-_]+$': {
+                                            type: 'object',
+                                            properties: {
+                                                type: {
+                                                    type: 'string',
+                                                    minLength: 1,
+                                                },
+                                                src: {
+                                                    type: 'string',
+                                                    minLength: 1,
+                                                },
+                                            },
+                                            required: ['type', 'src'],
+                                            additionalProperties: false,
+                                        },
+                                    },
+                                    additionalProperties: false,
+                                },
                             },
                             required: ['repo'],
                             additionalProperties: false,

package/src/task-builders/docs-ts-task-builder.js

@@ -35,12 +35,16 @@ export class DocsTsTaskBuilder extends TaskBuilder {
 
         const { rootDir } = project;
         const docsDir = rootDir.getChild('docs').getFilePath(project.version);
-        const srcDir = rootDir.getChild('src');
+        const srcPath = rootDir.getChild('src').getAllFilesGlob('ts');
 
         const task = () =>
-            _execa('typedoc', ['--out', docsDir, srcDir.absolutePath], {
-                stdio: 'inherit',
-            }).then(undefined, (err) => {
+            _execa(
+                'typedoc',
+                ['--out', docsDir, srcPath, '--entryPointStrategy', 'resolve'],
+                {
+                    stdio: 'inherit',
+                },
+            ).then(undefined, (err) => {
                 /*
                  * Do nothing. This handler prevents the gulp task from
                  * crashing with an unhandled error.

package/src/task-builders/package-container-task-builder.js

@@ -67,7 +67,7 @@ export class PackageContainerTaskBuilder extends TaskBuilder {
 
         const repo =
             typeof this._repo === 'undefined' ? definition.repo : this._repo;
-        const { buildFile, buildArgs } = definition;
+        const { buildFile, buildArgs, buildSecrets } = definition;
 
         const dockerBin = 'docker';
         const args = [
@@ -94,6 +94,12 @@ export class PackageContainerTaskBuilder extends TaskBuilder {
             args.push(`${key}=${buildArgs[key]}`);
         });
 
+        Object.keys(buildSecrets).forEach((key) => {
+            const { type, src } = buildSecrets[key];
+            args.push('--secret');
+            args.push(`id=${key},src=${src},type=${type}`);
+        });
+
         args.push('.');
 
         const task = () =>

package/src/task-builders/publish-container-task-builder.js

@@ -31,7 +31,7 @@ export class PublishContainerTaskBuilder extends TaskBuilder {
         super(
             // When specifying the container target, if it is not called default, this
             // will create a named task
-            `publish-container${target === 'default' ? '' : '-' + target}`,
+            `publish-container${target === 'default' ? '' : '-' + target}-${tag}`,
             `Publish container image for ${target}:${tag}`,
         );
 
@@ -71,6 +71,7 @@ export class PublishContainerTaskBuilder extends TaskBuilder {
                      * crashing with an unhandled error.
                      */
                 });
+            tagTask.displayName = `tag-${definition.name}-${tag}`;
             return tagTask;
         });
         const pushTaskList = semverComponents.map((tag) => {
@@ -84,6 +85,7 @@ export class PublishContainerTaskBuilder extends TaskBuilder {
                      * crashing with an unhandled error.
                      */
                 });
+            pushTask.displayName = `push-${definition.name}-${tag}`;
             return pushTask;
         });
 

package/src/task-builders/publish-task-builder.js

@@ -80,19 +80,25 @@ export class PublishTaskBuilder extends TaskBuilder {
         }
         // Type container
         else if (type === 'container') {
-            return [new PublishContainerTaskBuilder('default')];
+            return [
+                new PublishContainerTaskBuilder('default', project.version),
+            ];
         }
         // Type cli
         else if (type === 'cli') {
             if (containerTargetList.length > 0) {
-                return [new PublishContainerTaskBuilder('default')];
+                return [
+                    new PublishContainerTaskBuilder('default', project.version),
+                ];
             } else {
                 return [new PublishNpmTaskBuilder()];
             }
         }
         // Type api
         else if (type === 'api') {
-            return [new PublishContainerTaskBuilder('default')];
+            return [
+                new PublishContainerTaskBuilder('default', project.version),
+            ];
         }
         // Type ui (and potentially others that are not supported)
         else {

package/src/task-factories/api-task-factory.js

@@ -42,13 +42,9 @@ export class ApiTaskFactory extends TaskFactory {
         const additionalTaskList = (target) => {
             return [
                 new PackageContainerTaskBuilder(target),
-                new PublishContainerTaskBuilder(target),
+                new PublishContainerTaskBuilder(target, this._project.version),
             ];
         };
-        const additionalTasks = generateAdditionalContainerTasks(
-            this._project,
-            additionalTaskList,
-        );
 
         return [
             new CleanTaskBuilder(),
@@ -62,6 +58,11 @@ export class ApiTaskFactory extends TaskFactory {
             new BuildTaskBuilder(this._project),
             new PackageTaskBuilder(this._project),
             new PublishTaskBuilder(this._project),
-        ].concat(additionalTasks);
+            new PublishContainerTaskBuilder('default'),
+        ].concat(
+            generateAdditionalContainerTasks(this._project, additionalTaskList),
+        ); // Note: Instantiating the additional container tasks in a different
+        // order will break tests. This is less than ideal, but it will have
+        // to do for now.
     }
 }

package/src/task-factories/cli-task-factory.js

@@ -44,13 +44,11 @@ export class CliTaskFactory extends TaskFactory {
         const additionalTaskList = (target) => {
             return [
                 new PackageContainerTaskBuilder(target),
-                new PublishContainerTaskBuilder(target),
+                new PublishContainerTaskBuilder(target, this._project.version),
             ];
         };
-        const additionalTasks = generateAdditionalContainerTasks(
-            this._project,
-            additionalTaskList,
-        );
+
+        const hasContainer = this._project.getContainerTargets().length > 0;
 
         return [
             new CleanTaskBuilder(),
@@ -63,6 +61,19 @@ export class CliTaskFactory extends TaskFactory {
             new BuildTaskBuilder(this._project),
             new PackageTaskBuilder(this._project),
             new PublishTaskBuilder(this._project),
-        ].concat(additionalTasks);
+            hasContainer
+                ? new PublishContainerTaskBuilder('default')
+                : undefined,
+            // Note: Instantiating the additional container tasks in a different
+            // order will break tests. This is less than ideal, but it will have
+            // to do for now.
+        ]
+            .concat(
+                generateAdditionalContainerTasks(
+                    this._project,
+                    additionalTaskList,
+                ),
+            )
+            .filter(Boolean);
     }
 }

package/src/task-factories/container-task-factory.js

@@ -42,13 +42,9 @@ export class ContainerTaskFactory extends TaskFactory {
         const additionalTaskList = (target) => {
             return [
                 new PackageContainerTaskBuilder(target),
-                new PublishContainerTaskBuilder(target),
+                new PublishContainerTaskBuilder(target, this._project.version),
             ];
         };
-        const additionalTasks = generateAdditionalContainerTasks(
-            this._project,
-            additionalTaskList,
-        );
 
         return [
             new CleanTaskBuilder(),
@@ -59,6 +55,11 @@ export class ContainerTaskFactory extends TaskFactory {
             new DocsTaskBuilder(this._project),
             new PackageTaskBuilder(this._project),
             new PublishTaskBuilder(this._project),
-        ].concat(additionalTasks);
+            new PublishContainerTaskBuilder('default'),
+        ].concat(
+            generateAdditionalContainerTasks(this._project, additionalTaskList),
+        ); // Note: Instantiating the additional container tasks in a different
+        // order will break tests. This is less than ideal, but it will have
+        // to do for now.
     }
 }