@dotcom-tool-kit/circleci-npm 1.7.0-beta.2 → 1.8.1

package/lib/index.d.ts

@@ -4,6 +4,7 @@ export declare const tasks: (typeof NpmPublish)[];
 declare class PublishHook extends CircleCiConfigHook {
     job: string;
     jobOptions: {
+        context: string;
         requires: string[];
         filters: {
             branches: {

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;AAC9E,OAAO,UAA2B,MAAM,4CAA4C,CAAA;AAEpF,eAAO,MAAM,KAAK,uBAAe,CAAA;AAEjC,cAAM,WAAY,SAAQ,kBAAkB;IAC1C,GAAG,SAAqB;IACxB,UAAU;;;;;;;;;;MAMT;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;AAC9E,OAAO,UAA2B,MAAM,4CAA4C,CAAA;AAEpF,eAAO,MAAM,KAAK,uBAAe,CAAA;AAEjC,cAAM,WAAY,SAAQ,kBAAkB;IAC1C,GAAG,SAAqB;IACxB,UAAU;;;;;;;;;;;MAOT;CACF;AAED,eAAO,MAAM,KAAK;;CAEjB,CAAA"}

package/lib/index.js

@@ -10,6 +10,7 @@ class PublishHook extends circleci_config_1.default {
         super(...arguments);
         this.job = 'tool-kit/publish';
         this.jobOptions = {
+            context: 'npm-publish-token',
             requires: ['tool-kit/test'],
             filters: {
                 branches: { ignore: '/.*/' },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/circleci-npm",
-  "version": "1.7.0-beta.2",
+  "version": "1.8.1",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -10,9 +10,9 @@
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotcom-tool-kit/types": "^1.7.0-beta.2",
-    "@dotcom-tool-kit/circleci": "^1.7.0-beta.2",
-    "@dotcom-tool-kit/npm": "^1.7.0-beta.2"
+    "@dotcom-tool-kit/types": "^1.8.1",
+    "@dotcom-tool-kit/circleci": "^1.8.1",
+    "@dotcom-tool-kit/npm": "^1.8.1"
   },
   "repository": {
     "type": "git",

package/readme.md

@@ -23,7 +23,23 @@ And install this plugin's hooks:
 npx dotcom-tool-kit --install
 ```
 
-This will add the tool-kit/publish job to your `config.yml`.
+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. 
+
+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)
+
+```yaml
+	- tool-kit/publish:
+		context: npm-publish-token
+		requires:
+		- tool-kit/test
+		filters:
+		branches:
+			ignore: /.*/
+		tags:
+			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