@dotcom-tool-kit/circleci-npm 1.0.2-beta.14 → 1.0.2-beta.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +5 -5
- package/readme.md +33 -0
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dotcom-tool-kit/circleci-npm",
|
|
3
|
-
"version": "1.0.2-beta.
|
|
3
|
+
"version": "1.0.2-beta.17",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "lib",
|
|
6
6
|
"scripts": {
|
|
7
|
-
"test": "
|
|
7
|
+
"test": "cd ../../ ; npx jest --silent --projects plugins/circleci-npm"
|
|
8
8
|
},
|
|
9
9
|
"keywords": [],
|
|
10
10
|
"author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
|
|
11
11
|
"license": "ISC",
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@dotcom-tool-kit/types": "^1.0.2-beta.
|
|
14
|
-
"@dotcom-tool-kit/circleci": "^1.0.2-beta.
|
|
15
|
-
"@dotcom-tool-kit/npm": "^1.0.2-beta.
|
|
13
|
+
"@dotcom-tool-kit/types": "^1.0.2-beta.17",
|
|
14
|
+
"@dotcom-tool-kit/circleci": "^1.0.2-beta.17",
|
|
15
|
+
"@dotcom-tool-kit/npm": "^1.0.2-beta.17"
|
|
16
16
|
},
|
|
17
17
|
"repository": {
|
|
18
18
|
"type": "git",
|
package/readme.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# `circleci-npm` Tool Kit plugin
|
|
2
|
+
|
|
3
|
+
This plugin is for managing the `publish:tag` hook that is run from circleci to publish the built package to the npm registry.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install `@dotcom-tool-kit/circleci-npm` as a `devDependency` in your app:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install --save-dev @dotcom-tool-kit/circleci-npm
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Add the plugin to your [Tool Kit configuration](https://github.com/financial-times/dotcom-tool-kit/blob/main/readme.md#configuration):
|
|
14
|
+
|
|
15
|
+
```yaml
|
|
16
|
+
plugins:
|
|
17
|
+
- '@dotcom-tool-kit/circleci-npm'
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
And install this plugin's hooks:
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
npx dotcom-tool-kit --install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
This will add the tool-kit/publish job to your `config.yml`.
|
|
27
|
+
|
|
28
|
+
## Hooks
|
|
29
|
+
|
|
30
|
+
| Event | Description | Installed to...|
|
|
31
|
+
|-|-|-|
|
|
32
|
+
| `publish:tag` | Publishes the built package to the npm registry | `publish` job in `.circle/config.yml` |
|
|
33
|
+
|