dotcom-tool-kit 1.7.0-beta.3 → 1.7.0

package/lib/install.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,MAAM,EAAc,MAAM,UAAU,CAAA;AAE7C,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmC1E"}
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,MAAM,EAAc,MAAM,UAAU,CAAA;AAE7C,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAqC1E"}

package/lib/install.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const error_1 = require("@dotcom-tool-kit/error");
 const options_1 = require("@dotcom-tool-kit/options");
 const config_1 = require("./config");
+const postInstall_1 = require("./postInstall");
 async function installHooks(logger) {
     const config = await (0, config_1.loadConfig)(logger);
     const tasks = Object.values(config.hooks).map((hook) => async () => {
@@ -29,6 +30,8 @@ async function installHooks(logger) {
             }
         }
     }
+    // Hack: for now we will do a postinstall, later we shall refactor circleciconfighook so we dont need to postinstall
+    await (0, postInstall_1.postInstall)(logger);
     if (errors.length) {
         const error = new error_1.ToolKitError('could not automatically install hooks:');
         error.details = errors.map((error) => `- ${error.message}`).join('\n');

package/lib/postInstall.d.ts

@@ -0,0 +1,7 @@
+import type { Logger } from 'winston';
+/**
+ * This step adds the tags only filter to rest of the jobs in the workflow if there is a job that contains the semverRegex.
+ * CircleCI will only run the jobs if the rest of the jobs have the tags filter.
+ */
+export declare function postInstall(logger: Logger): Promise<void>;
+//# sourceMappingURL=postInstall.d.ts.map

package/lib/postInstall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postInstall.d.ts","sourceRoot":"","sources":["../src/postInstall.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC;;;GAGG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,iBAgC/C"}

package/lib/postInstall.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postInstall = void 0;
+const tslib_1 = require("tslib");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_1 = require("fs");
+const npm_publish_1 = require("@dotcom-tool-kit/npm/lib/tasks/npm-publish");
+const YAML = (0, tslib_1.__importStar)(require("yaml"));
+const lodash_merge_1 = (0, tslib_1.__importDefault)(require("lodash.merge"));
+const circleci_1 = require("@dotcom-tool-kit/types/lib/circleci");
+/**
+ * This step adds the tags only filter to rest of the jobs in the workflow if there is a job that contains the semverRegex.
+ * CircleCI will only run the jobs if the rest of the jobs have the tags filter.
+ */
+async function postInstall(logger) {
+    const circleConfigPath = path_1.default.resolve(process.cwd(), '.circleci/config.yml');
+    try {
+        const rawCircleConfig = await fs_1.promises.readFile(circleConfigPath, 'utf8');
+        if (rawCircleConfig && rawCircleConfig.includes(npm_publish_1.semVerRegex.source) && rawCircleConfig.startsWith(circleci_1.automatedComment)) {
+            logger.verbose('running postInstall step');
+            const yml = YAML.parseDocument(rawCircleConfig);
+            const workflows = yml.get('workflows');
+            const toolkitWorkflow = workflows.get('tool-kit');
+            const jobs = toolkitWorkflow.get('jobs');
+            jobs === null || jobs === void 0 ? void 0 : jobs.items.forEach((jobItem, index) => {
+                const tagsFilterConfig = { filters: { tags: { only: `${npm_publish_1.semVerRegex}` } } };
+                if (jobItem.type === 'PLAIN') { // eg. - checkout
+                    const node = YAML.createNode({ [jobItem.value]: tagsFilterConfig });
+                    jobs.items[index] = node;
+                }
+                else {
+                    const job = jobItem.items[0];
+                    const existingFilter = job.value.items.filter((item) => item.key.value === 'filters')[0];
+                    const merged = existingFilter ? (0, lodash_merge_1.default)(existingFilter.toJSON(), tagsFilterConfig) : tagsFilterConfig;
+                    const node = YAML.createNode(merged['filters']);
+                    job.value.set('filters', node);
+                }
+            });
+            logger.info(`writing postInstall results to file ${circleConfigPath}`);
+            await fs_1.promises.writeFile(circleConfigPath, yml.toString());
+        }
+    }
+    catch (error) {
+        // Not an error if config file doesn't exist
+        if (error.code !== 'ENOENT') {
+            throw error;
+        }
+    }
+}
+exports.postInstall = postInstall;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "1.7.0-beta.3",
+  "version": "1.7.0",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -22,6 +22,7 @@
   "devDependencies": {
     "@dotcom-tool-kit/circleci": "file:../../plugins/circleci",
     "@jest/globals": "^27.4.6",
+    "@types/lodash.merge": "^4.6.6",
     "@types/lodash.mergewith": "^4.6.6",
     "@types/node": "^12.20.24",
     "chai": "^4.3.4",
@@ -30,18 +31,20 @@
     "winston": "^3.5.1"
   },
   "dependencies": {
-    "@dotcom-tool-kit/error": "^1.7.0-beta.3",
-    "@dotcom-tool-kit/hook": "^1.7.0-beta.3",
-    "@dotcom-tool-kit/logger": "^1.7.0-beta.3",
-    "@dotcom-tool-kit/options": "^1.7.0-beta.3",
-    "@dotcom-tool-kit/types": "^1.7.0-beta.3",
-    "@dotcom-tool-kit/wait-for-ok": "^1.7.0-beta.3",
+    "@dotcom-tool-kit/error": "^1.7.0",
+    "@dotcom-tool-kit/hook": "^1.7.0",
+    "@dotcom-tool-kit/logger": "^1.7.0",
+    "@dotcom-tool-kit/options": "^1.7.0",
+    "@dotcom-tool-kit/types": "^1.7.0",
+    "@dotcom-tool-kit/wait-for-ok": "^1.7.0",
     "cosmiconfig": "^7.0.0",
     "import-from": "^3.0.0",
+    "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
     "minimist": "^1.2.5",
     "resolve-from": "^5.0.0",
-    "tslib": "^1.14.1"
+    "tslib": "^1.14.1",
+    "yaml": "^1.10.2"
   },
   "engines": {
     "node": ">=8.0.0"