npm-update-package 1.3.1 → 1.3.4
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/README.md +22 -25
- package/dist/package.json +7 -7
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
[](https://badge.fury.io/js/npm-update-package)
|
|
2
|
-
[](https://standardjs.com)
|
|
3
|
-
[](https://github.com/npm-update-package/npm-update-package/actions/workflows/eslint.yml)
|
|
4
|
-
[](https://github.com/npm-update-package/npm-update-package/actions/workflows/test.yml)
|
|
5
2
|
|
|
6
3
|
# npm-update-package
|
|
7
4
|
|
|
@@ -35,11 +32,11 @@ CLI tool for creating pull requests to update npm packages
|
|
|
35
32
|
- [`--reviewers`](#--reviewers)
|
|
36
33
|
- [`--reviewers-sample-size`](#--reviewers-sample-size)
|
|
37
34
|
- [GitHub token](#github-token)
|
|
38
|
-
- [
|
|
35
|
+
- [How to run on GitHub Actions](#how-to-run-on-github-actions)
|
|
39
36
|
- [Use token of GitHub Actions](#use-token-of-github-actions)
|
|
40
37
|
- [Use token of GitHub App](#use-token-of-github-app)
|
|
41
38
|
- [Use Personal access token](#use-personal-access-token)
|
|
42
|
-
- [
|
|
39
|
+
- [Architecture](#architecture)
|
|
43
40
|
- [FAQ](#faq)
|
|
44
41
|
- [What is the purpose of npm-update-package?](#what-is-the-purpose-of-npm-update-package)
|
|
45
42
|
- [What should I do if conflicts occurred in the pull request?](#what-should-i-do-if-conflicts-occurred-in-the-pull-request)
|
|
@@ -61,7 +58,7 @@ CLI tool for creating pull requests to update npm packages
|
|
|
61
58
|
## Usage
|
|
62
59
|
|
|
63
60
|
```sh
|
|
64
|
-
npx npm-update-package --github-token
|
|
61
|
+
npx npm-update-package --github-token <github-token>
|
|
65
62
|
```
|
|
66
63
|
|
|
67
64
|
## Options
|
|
@@ -82,7 +79,7 @@ Example:
|
|
|
82
79
|
|
|
83
80
|
```sh
|
|
84
81
|
npx npm-update-package \
|
|
85
|
-
--github-token
|
|
82
|
+
--github-token <github-token> \
|
|
86
83
|
--assignees alice bob
|
|
87
84
|
```
|
|
88
85
|
|
|
@@ -99,7 +96,7 @@ Example:
|
|
|
99
96
|
|
|
100
97
|
```sh
|
|
101
98
|
npx npm-update-package \
|
|
102
|
-
--github-token
|
|
99
|
+
--github-token <github-token> \
|
|
103
100
|
--assignees alice bob \
|
|
104
101
|
--assignees-sample-size 1
|
|
105
102
|
```
|
|
@@ -128,7 +125,7 @@ Example:
|
|
|
128
125
|
|
|
129
126
|
```sh
|
|
130
127
|
npx npm-update-package \
|
|
131
|
-
--github-token
|
|
128
|
+
--github-token <github-token> \
|
|
132
129
|
--commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
|
|
133
130
|
```
|
|
134
131
|
|
|
@@ -157,7 +154,7 @@ Example:
|
|
|
157
154
|
|
|
158
155
|
```sh
|
|
159
156
|
npx npm-update-package \
|
|
160
|
-
--github-token
|
|
157
|
+
--github-token <github-token> \
|
|
161
158
|
--dependency-types dependencies devDependencies
|
|
162
159
|
```
|
|
163
160
|
|
|
@@ -175,7 +172,7 @@ Example:
|
|
|
175
172
|
|
|
176
173
|
```sh
|
|
177
174
|
npx npm-update-package \
|
|
178
|
-
--github-token
|
|
175
|
+
--github-token <github-token> \
|
|
179
176
|
--fetch-release-notes false
|
|
180
177
|
```
|
|
181
178
|
|
|
@@ -193,7 +190,7 @@ Example:
|
|
|
193
190
|
|
|
194
191
|
```sh
|
|
195
192
|
npx npm-update-package \
|
|
196
|
-
--github-token
|
|
193
|
+
--github-token <github-token> \
|
|
197
194
|
--fetch-sleep-time 2000
|
|
198
195
|
```
|
|
199
196
|
|
|
@@ -210,7 +207,7 @@ Example:
|
|
|
210
207
|
|
|
211
208
|
```sh
|
|
212
209
|
npx npm-update-package \
|
|
213
|
-
--github-token
|
|
210
|
+
--github-token <github-token> \
|
|
214
211
|
--git-user-email alice@example.com
|
|
215
212
|
```
|
|
216
213
|
|
|
@@ -227,7 +224,7 @@ Example:
|
|
|
227
224
|
|
|
228
225
|
```sh
|
|
229
226
|
npx npm-update-package \
|
|
230
|
-
--github-token
|
|
227
|
+
--github-token <github-token> \
|
|
231
228
|
--git-user-name alice
|
|
232
229
|
```
|
|
233
230
|
|
|
@@ -253,7 +250,7 @@ Example:
|
|
|
253
250
|
|
|
254
251
|
```sh
|
|
255
252
|
npx npm-update-package \
|
|
256
|
-
--github-token
|
|
253
|
+
--github-token <github-token> \
|
|
257
254
|
--ignore-packages @types/jest jest
|
|
258
255
|
```
|
|
259
256
|
|
|
@@ -283,7 +280,7 @@ Example:
|
|
|
283
280
|
|
|
284
281
|
```sh
|
|
285
282
|
npx npm-update-package \
|
|
286
|
-
--github-token
|
|
283
|
+
--github-token <github-token> \
|
|
287
284
|
--log-level debug
|
|
288
285
|
```
|
|
289
286
|
|
|
@@ -309,7 +306,7 @@ Example:
|
|
|
309
306
|
|
|
310
307
|
```sh
|
|
311
308
|
npx npm-update-package \
|
|
312
|
-
--github-token
|
|
309
|
+
--github-token <github-token> \
|
|
313
310
|
--outdated-pr-strategy create
|
|
314
311
|
```
|
|
315
312
|
|
|
@@ -334,7 +331,7 @@ Example:
|
|
|
334
331
|
|
|
335
332
|
```sh
|
|
336
333
|
npx npm-update-package \
|
|
337
|
-
--github-token
|
|
334
|
+
--github-token <github-token> \
|
|
338
335
|
--package-manager yarn
|
|
339
336
|
```
|
|
340
337
|
|
|
@@ -352,7 +349,7 @@ Example:
|
|
|
352
349
|
|
|
353
350
|
```sh
|
|
354
351
|
npx npm-update-package \
|
|
355
|
-
--github-token
|
|
352
|
+
--github-token <github-token> \
|
|
356
353
|
--pr-body-github-host "github.example"
|
|
357
354
|
```
|
|
358
355
|
|
|
@@ -369,7 +366,7 @@ Example:
|
|
|
369
366
|
|
|
370
367
|
```sh
|
|
371
368
|
npx npm-update-package \
|
|
372
|
-
--github-token
|
|
369
|
+
--github-token <github-token> \
|
|
373
370
|
--pr-body-notes "**:warning: Please see diff and release notes before merging.**"
|
|
374
371
|
```
|
|
375
372
|
|
|
@@ -397,7 +394,7 @@ Example:
|
|
|
397
394
|
|
|
398
395
|
```sh
|
|
399
396
|
npx npm-update-package \
|
|
400
|
-
--github-token
|
|
397
|
+
--github-token <github-token> \
|
|
401
398
|
--pr-title "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
|
|
402
399
|
```
|
|
403
400
|
|
|
@@ -414,7 +411,7 @@ Example:
|
|
|
414
411
|
|
|
415
412
|
```sh
|
|
416
413
|
npx npm-update-package \
|
|
417
|
-
--github-token
|
|
414
|
+
--github-token <github-token> \
|
|
418
415
|
--reviewers alice bob
|
|
419
416
|
```
|
|
420
417
|
|
|
@@ -431,7 +428,7 @@ Example:
|
|
|
431
428
|
|
|
432
429
|
```sh
|
|
433
430
|
npx npm-update-package \
|
|
434
|
-
--github-token
|
|
431
|
+
--github-token <github-token> \
|
|
435
432
|
--reviewers alice bob \
|
|
436
433
|
--reviewers-sample-size 1
|
|
437
434
|
```
|
|
@@ -465,7 +462,7 @@ We recommend using GitHub App for the following reasons.
|
|
|
465
462
|
|
|
466
463
|
Creating a GitHub App may be tedious, but you only have to do it once the first time.
|
|
467
464
|
|
|
468
|
-
##
|
|
465
|
+
## How to run on GitHub Actions
|
|
469
466
|
|
|
470
467
|
### Use token of GitHub Actions
|
|
471
468
|
|
|
@@ -555,7 +552,7 @@ jobs:
|
|
|
555
552
|
|
|
556
553
|
See working example on [example-pat](https://github.com/npm-update-package/example-pat).
|
|
557
554
|
|
|
558
|
-
##
|
|
555
|
+
## Architecture
|
|
559
556
|
|
|
560
557
|
The following shows the process flow of npm-update-package.
|
|
561
558
|
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.4",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -18,14 +18,14 @@
|
|
|
18
18
|
"@octokit/rest": "19.0.3",
|
|
19
19
|
"commander": "9.4.0",
|
|
20
20
|
"execa": "5.1.1",
|
|
21
|
-
"fp-ts": "2.12.
|
|
21
|
+
"fp-ts": "2.12.2",
|
|
22
22
|
"http-status-codes": "2.2.0",
|
|
23
23
|
"io-ts": "2.2.16",
|
|
24
24
|
"lodash": "4.14.2",
|
|
25
|
-
"log4js": "6.6.
|
|
26
|
-
"mustache": "4.
|
|
25
|
+
"log4js": "6.6.1",
|
|
26
|
+
"mustache": "4.2.0",
|
|
27
27
|
"node-fetch": "2.6.7",
|
|
28
|
-
"npm-check-updates": "
|
|
28
|
+
"npm-check-updates": "16.0.1",
|
|
29
29
|
"parse-github-url": "1.0.2",
|
|
30
30
|
"semver": "7.3.7",
|
|
31
31
|
"sleep-promise": "9.1.0",
|
|
@@ -36,12 +36,12 @@
|
|
|
36
36
|
"@tsconfig/node14": "1.0.3",
|
|
37
37
|
"@types/jest": "28.1.6",
|
|
38
38
|
"@types/lodash": "4.14.182",
|
|
39
|
-
"@types/mustache": "4.1
|
|
39
|
+
"@types/mustache": "4.2.1",
|
|
40
40
|
"@types/node": "14.18.22",
|
|
41
41
|
"@types/node-fetch": "2.6.2",
|
|
42
42
|
"@types/parse-github-url": "1.0.0",
|
|
43
43
|
"@types/semver": "7.3.10",
|
|
44
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
44
|
+
"@typescript-eslint/eslint-plugin": "5.31.0",
|
|
45
45
|
"eslint": "8.20.0",
|
|
46
46
|
"eslint-config-lodash": "1.1.0",
|
|
47
47
|
"eslint-config-standard-with-typescript": "22.0.0",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.4",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -18,14 +18,14 @@
|
|
|
18
18
|
"@octokit/rest": "19.0.3",
|
|
19
19
|
"commander": "9.4.0",
|
|
20
20
|
"execa": "5.1.1",
|
|
21
|
-
"fp-ts": "2.12.
|
|
21
|
+
"fp-ts": "2.12.2",
|
|
22
22
|
"http-status-codes": "2.2.0",
|
|
23
23
|
"io-ts": "2.2.16",
|
|
24
24
|
"lodash": "4.14.2",
|
|
25
|
-
"log4js": "6.6.
|
|
26
|
-
"mustache": "4.
|
|
25
|
+
"log4js": "6.6.1",
|
|
26
|
+
"mustache": "4.2.0",
|
|
27
27
|
"node-fetch": "2.6.7",
|
|
28
|
-
"npm-check-updates": "
|
|
28
|
+
"npm-check-updates": "16.0.1",
|
|
29
29
|
"parse-github-url": "1.0.2",
|
|
30
30
|
"semver": "7.3.7",
|
|
31
31
|
"sleep-promise": "9.1.0",
|
|
@@ -36,12 +36,12 @@
|
|
|
36
36
|
"@tsconfig/node14": "1.0.3",
|
|
37
37
|
"@types/jest": "28.1.6",
|
|
38
38
|
"@types/lodash": "4.14.182",
|
|
39
|
-
"@types/mustache": "4.1
|
|
39
|
+
"@types/mustache": "4.2.1",
|
|
40
40
|
"@types/node": "14.18.22",
|
|
41
41
|
"@types/node-fetch": "2.6.2",
|
|
42
42
|
"@types/parse-github-url": "1.0.0",
|
|
43
43
|
"@types/semver": "7.3.10",
|
|
44
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
44
|
+
"@typescript-eslint/eslint-plugin": "5.31.0",
|
|
45
45
|
"eslint": "8.20.0",
|
|
46
46
|
"eslint-config-lodash": "1.1.0",
|
|
47
47
|
"eslint-config-standard-with-typescript": "22.0.0",
|