@dotcom-tool-kit/circleci-npm 2.0.9 → 3.0.0

package/lib/index.d.ts

@@ -8,11 +8,9 @@ declare class PublishHook extends CircleCiConfigHook {
             branches: {
                 ignore: string;
             };
-            tags: {
-                only: string;
-            };
         };
     };
+    runOnVersionTags: boolean;
 }
 export declare const hooks: {
     'publish:tag': typeof PublishHook;

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,+CAA+C,CAAA;AAG9E,cAAM,WAAY,SAAQ,kBAAkB;IAC1C,GAAG,SAAqB;IACxB,UAAU;;;;;;;;;;;MAOT;CACF;AAED,eAAO,MAAM,KAAK;;CAEjB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,+CAA+C,CAAA;AAE9E,cAAM,WAAY,SAAQ,kBAAkB;IAC1C,GAAG,SAAqB;IACxB,UAAU;;;;;;;;MAMT;IACD,gBAAgB,UAAO;CACxB;AAED,eAAO,MAAM,KAAK;;CAEjB,CAAA"}

package/lib/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.hooks = void 0;
 const tslib_1 = require("tslib");
 const circleci_config_1 = (0, tslib_1.__importDefault)(require("@dotcom-tool-kit/circleci/lib/circleci-config"));
-const npm_1 = require("@dotcom-tool-kit/types/lib/npm");
 class PublishHook extends circleci_config_1.default {
     constructor() {
         super(...arguments);
@@ -12,10 +11,10 @@ class PublishHook extends circleci_config_1.default {
             context: 'npm-publish-token',
             requires: ['tool-kit/test'],
             filters: {
-                branches: { ignore: '/.*/' },
-                tags: { only: `${npm_1.semVerRegex}` }
+                branches: { ignore: '/.*/' }
             }
         };
+        this.runOnVersionTags = true;
     }
 }
 exports.hooks = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/circleci-npm",
-  "version": "2.0.9",
+  "version": "3.0.0",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -10,9 +10,10 @@
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotcom-tool-kit/types": "^2.6.1",
-    "@dotcom-tool-kit/circleci": "^2.1.6",
-    "@dotcom-tool-kit/npm": "^2.0.9"
+    "@dotcom-tool-kit/types": "^2.7.0",
+    "@dotcom-tool-kit/circleci": "^3.0.0",
+    "@dotcom-tool-kit/npm": "^2.0.11",
+    "tslib": "^2.3.1"
   },
   "repository": {
     "type": "git",

package/readme.md

@@ -1,7 +1,9 @@
-# `circleci-npm` Tool Kit plugin
+# @dotcom-tool-kit/circleci-npm
 
 This plugin is for managing the `publish:tag` hook that is run from circleci to publish the built package to the npm registry.
 
+The tool-kit/publish job is triggered in your circleci pipeline once you do a release with a tag matching the semver format. If your tag is a beta version, i.e. `v1.6.0-beta.1`, then the publish job will tag your build as a prerelease version. If your tag is a release version, i.e. `v1.6.0`, then the publish job will tag your build as the latest version.
+
 ## Installation
 
 Install `@dotcom-tool-kit/circleci-npm` as a `devDependency` in your app:
@@ -17,13 +19,21 @@ plugins:
 	- '@dotcom-tool-kit/circleci-npm'
 ```
 
-And install this plugin's hooks:
+Install this plugin's hooks:
 
 ```sh
 npx dotcom-tool-kit --install
 ```
 
-If you have the automated comment `# CONFIG GENERATED BY DOTCOM-TOOL-KIT, DO NOT EDIT BY HAND\n` in your `config.yml`, this will add the tool-kit/publish job to your `config.yml`. Furthermore, this will add the tags filter to the rest of the tool-kit jobs in your workflow in `config.yml`, as CircleCI will only run the jobs if the rest of the jobs have the tags filter. 
+### For Tool Kit generated CircleCI `config.yml`
+
+If you are migrating your project to Tool Kit for the first time then this plugin can generate a new `.circleci/config.yml` file for your project including Tool Kit configured workflows. To use this feature please delete or rename your existing CircleCI `config.yml` file before running the install command.
+
+### Adding to an existing Tool Kit generated CircleCI `config.yml`
+
+If you have the automated comment `# CONFIG GENERATED BY DOTCOM-TOOL-KIT, DO NOT EDIT BY HAND\n` in your `config.yml`, running the install command will add the tool-kit/publish job to your `config.yml`. Furthermore, this will add the tags filter to the rest of the tool-kit jobs in your workflow in `config.yml`, as CircleCI will only run the jobs if the rest of the jobs have the tags filter.
+
+### Adding to a custom CircleCI `config.yml`
 
 If you don't have the automated comment in your `config.yml` and therefore choose to add the tool-kit/publish job manually, (1) copy and paste the below code snippet and (2) add the tags filter to the rest of the tool-kit jobs (you may refer to dotcom-tool-kit/core/sandbox/.circleci/config.yml as an example for this)
 
@@ -39,11 +49,8 @@ If you don't have the automated comment in your `config.yml` and therefore choos
 			only: /^v\d+\.\d+\.\d+(-.+)?/
 ```
 
-The tool-kit/publish job is triggered in your circleci pipeline once you do a release with a tag matching the semver format, e.g. `v1.6.0-beta.1`, `v1.6.0`. If your tag is a beta version, i.e. `v1.6.0-beta.1`, then the publish job will tag your build as a prerelease version. But if your tag is a release version, i.e. `v1.6.0`, then the publish job will tag your build as the latest version.
-
 ## Hooks
 
-| Event | Description | Installed to...|
-|-|-|-|
-| `publish:tag` | Publishes the built package to the npm registry | `publish` job in `.circle/config.yml`  |
-
+| Event | Description | Installed to...| Default tasks |
+|-|-|-|-|
+| `publish:tag` | Publishes the built package to the npm registry | `publish` job in `.circle/config.yml`  | NpmPublish |