npm-update-package 0.52.0 → 0.52.1

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.
Files changed (3) hide show
  1. package/README.md +81 -30
  2. package/dist/package.json +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -7,6 +7,38 @@
7
7
 
8
8
  CLI tool for creating pull requests to update npm packages
9
9
 
10
+ ## Table of Contents
11
+
12
+ <!-- START doctoc generated TOC please keep comment here to allow auto update -->
13
+ <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
14
+
15
+ - [Usage](#usage)
16
+ - [Options](#options)
17
+ - [assignees](#assignees)
18
+ - [commitMessage](#commitmessage)
19
+ - [fetchReleaseNotes](#fetchreleasenotes)
20
+ - [fetchSleepTime](#fetchsleeptime)
21
+ - [githubToken](#githubtoken)
22
+ - [ignorePackages](#ignorepackages)
23
+ - [logLevel](#loglevel)
24
+ - [packageManager](#packagemanager)
25
+ - [prBodyNotes](#prbodynotes)
26
+ - [prTitle](#prtitle)
27
+ - [reviewers](#reviewers)
28
+ - [GitHub token](#github-token)
29
+ - [Examples](#examples)
30
+ - [Use token of GitHub Actions](#use-token-of-github-actions)
31
+ - [Use token of GitHub App](#use-token-of-github-app)
32
+ - [Use Personal access token](#use-personal-access-token)
33
+ - [Use Yarn](#use-yarn)
34
+ - [Flow](#flow)
35
+ - [FAQ](#faq)
36
+ - [What is the purpose of npm-update-package?](#what-is-the-purpose-of-npm-update-package)
37
+ - [What should I do if conflicts occurred in the pull request?](#what-should-i-do-if-conflicts-occurred-in-the-pull-request)
38
+ - [How to development](#how-to-development)
39
+
40
+ <!-- END doctoc generated TOC please keep comment here to allow auto update -->
41
+
10
42
  ## Usage
11
43
 
12
44
  ```sh
@@ -15,19 +47,20 @@ npx npm-update-package --github-token $GITHUB_TOKEN
15
47
 
16
48
  ## Options
17
49
 
18
- You can customize behavior via command-line options.
50
+ You can customize behavior via CLI options.
19
51
  Some options can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
20
52
 
21
- ### `--assignees`
53
+ ### assignees
22
54
 
23
55
  User names to assign to pull request.
24
56
 
25
57
  |Name|Value|
26
58
  |---|---|
59
+ |cli|`--assignees`|
27
60
  |type|string[]|
28
61
  |required|false|
29
62
 
30
- #### Example
63
+ Example:
31
64
 
32
65
  ```sh
33
66
  npx npm-update-package \
@@ -35,17 +68,18 @@ npx npm-update-package \
35
68
  --assignees octocat mona
36
69
  ```
37
70
 
38
- ### `--commit-message`
71
+ ### commitMessage
39
72
 
40
73
  Commit message template.
41
74
 
42
75
  |Name|Value|
43
76
  |---|---|
77
+ |cli|`--commit-message`|
44
78
  |type|string|
45
79
  |required|false|
46
80
  |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
47
81
 
48
- #### Available variables
82
+ Available variables:
49
83
 
50
84
  |Variable|Description|
51
85
  |---|---|
@@ -55,7 +89,7 @@ Commit message template.
55
89
  |`level`|Semver level (`major`/`minor`/`patch`)|
56
90
  |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
57
91
 
58
- #### Example
92
+ Example:
59
93
 
60
94
  ```sh
61
95
  npx npm-update-package \
@@ -63,17 +97,18 @@ npx npm-update-package \
63
97
  --commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
64
98
  ```
65
99
 
66
- ### `--fetch-release-notes`
100
+ ### fetchReleaseNotes
67
101
 
68
102
  Whether to fetch release notes.
69
103
 
70
104
  |Name|Value|
71
105
  |---|---|
106
+ |cli|`--fetch-release-notes`|
72
107
  |type|boolean|
73
108
  |required|false|
74
109
  |default|`true`|
75
110
 
76
- #### Example
111
+ Example:
77
112
 
78
113
  ```sh
79
114
  npx npm-update-package \
@@ -81,17 +116,18 @@ npx npm-update-package \
81
116
  --fetch-release-notes false
82
117
  ```
83
118
 
84
- ### `--fetch-sleep-time`
119
+ ### fetchSleepTime
85
120
 
86
121
  Sleep time between fetching (ms).
87
122
 
88
123
  |Name|Value|
89
124
  |---|---|
125
+ |cli|`--fetch-sleep-time`|
90
126
  |type|number|
91
127
  |required|false|
92
128
  |default|`1000`|
93
129
 
94
- #### Example
130
+ Example:
95
131
 
96
132
  ```sh
97
133
  npx npm-update-package \
@@ -99,25 +135,27 @@ npx npm-update-package \
99
135
  --fetch-sleep-time 2000
100
136
  ```
101
137
 
102
- ### `--github-token`
138
+ ### githubToken
103
139
 
104
140
  [GitHub token](#github-token).
105
141
 
106
142
  |Name|Value|
107
143
  |---|---|
144
+ |cli|`--github-token`|
108
145
  |type|string|
109
146
  |required|true|
110
147
 
111
- ### `--ignore-packages`
148
+ ### ignorePackages
112
149
 
113
150
  Package names to ignore.
114
151
 
115
152
  |Name|Value|
116
153
  |---|---|
154
+ |cli|`--ignore-packages`|
117
155
  |type|string[]|
118
156
  |required|false|
119
157
 
120
- #### Example
158
+ Example:
121
159
 
122
160
  ```sh
123
161
  npx npm-update-package \
@@ -125,17 +163,18 @@ npx npm-update-package \
125
163
  --ignore-packages @types/jest jest
126
164
  ```
127
165
 
128
- ### `--log-level`
166
+ ### logLevel
129
167
 
130
168
  Log level to show.
131
169
 
132
170
  |Name|Value|
133
171
  |---|---|
172
+ |cli|`--log-level`|
134
173
  |type|string|
135
174
  |required|false|
136
175
  |default|`info`|
137
176
 
138
- #### Allowed values
177
+ Allowed values:
139
178
 
140
179
  |Value|Description|
141
180
  |---|---|
@@ -147,7 +186,7 @@ Log level to show.
147
186
  |`debug`|Output fatal/error/warn/info/debug logs.|
148
187
  |`trace`|Output fatal/error/warn/info/debug/trace logs.|
149
188
 
150
- #### Example
189
+ Example:
151
190
 
152
191
  ```sh
153
192
  npx npm-update-package \
@@ -155,24 +194,25 @@ npx npm-update-package \
155
194
  --log-level debug
156
195
  ```
157
196
 
158
- ### `--package-manager`
197
+ ### packageManager
159
198
 
160
199
  Package manager of your project.
161
200
 
162
201
  |Name|Value|
163
202
  |---|---|
203
+ |cli|`--package-manager`|
164
204
  |type|string|
165
205
  |required|false|
166
206
  |default|`npm`|
167
207
 
168
- #### Allowed values
208
+ Allowed values:
169
209
 
170
210
  |Value|Description|
171
211
  |---|---|
172
212
  |`npm`|npm|
173
213
  |`yarn`|Yarn|
174
214
 
175
- #### Example
215
+ Example:
176
216
 
177
217
  ```sh
178
218
  npx npm-update-package \
@@ -180,16 +220,17 @@ npx npm-update-package \
180
220
  --package-manager yarn
181
221
  ```
182
222
 
183
- ### `--pr-body-notes`
223
+ ### prBodyNotes
184
224
 
185
225
  Additional notes for Pull request body.
186
226
 
187
227
  |Name|Value|
188
228
  |---|---|
229
+ |cli|`--pr-body-notes`|
189
230
  |type|string|
190
231
  |required|false|
191
232
 
192
- #### Example
233
+ Example:
193
234
 
194
235
  ```sh
195
236
  npx npm-update-package \
@@ -197,17 +238,18 @@ npx npm-update-package \
197
238
  --pr-body-notes "**:warning: Please see diff and release notes before merging.**"
198
239
  ```
199
240
 
200
- ### `--pr-title`
241
+ ### prTitle
201
242
 
202
243
  Pull request title template.
203
244
 
204
245
  |Name|Value|
205
246
  |---|---|
247
+ |cli|`--pr-title`|
206
248
  |type|string|
207
249
  |required|false|
208
250
  |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
209
251
 
210
- #### Available variables
252
+ Available variables:
211
253
 
212
254
  |Variable|Description|
213
255
  |---|---|
@@ -217,7 +259,7 @@ Pull request title template.
217
259
  |`level`|Semver level (`major`/`minor`/`patch`)|
218
260
  |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
219
261
 
220
- #### Example
262
+ Example:
221
263
 
222
264
  ```sh
223
265
  npx npm-update-package \
@@ -225,16 +267,17 @@ npx npm-update-package \
225
267
  --pr-title "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
226
268
  ```
227
269
 
228
- ### `--reviewers`
270
+ ### reviewers
229
271
 
230
272
  User names to request reviews.
231
273
 
232
274
  |Name|Value|
233
275
  |---|---|
276
+ |cli|`--reviewers`|
234
277
  |type|string[]|
235
278
  |required|false|
236
279
 
237
- #### Example
280
+ Example:
238
281
 
239
282
  ```sh
240
283
  npx npm-update-package \
@@ -273,7 +316,7 @@ Creating a GitHub App may be tedious, but you only have to do it once the first
273
316
 
274
317
  ## Examples
275
318
 
276
- - [Use token of GitHub Actions](https://github.com/npm-update-package/example-github-actions)
319
+ ### Use token of GitHub Actions
277
320
 
278
321
  ```yaml
279
322
  name: npm-update-package
@@ -296,7 +339,9 @@ jobs:
296
339
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
297
340
  ```
298
341
 
299
- - [Use token of GitHub App](https://github.com/npm-update-package/example-github-app)
342
+ See working example on [example-github-actions](https://github.com/npm-update-package/example-github-actions).
343
+
344
+ ### Use token of GitHub App
300
345
 
301
346
  ```yaml
302
347
  name: npm-update-package
@@ -327,7 +372,9 @@ jobs:
327
372
  GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
328
373
  ```
329
374
 
330
- - [Use Personal access token](https://github.com/npm-update-package/example-pat)
375
+ See working example on [example-github-app](https://github.com/npm-update-package/example-github-app).
376
+
377
+ ### Use Personal access token
331
378
 
332
379
  ```yaml
333
380
  name: npm-update-package
@@ -352,7 +399,9 @@ jobs:
352
399
  GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
353
400
  ```
354
401
 
355
- - [Use Yarn](https://github.com/npm-update-package/example-yarn)
402
+ See working example on [example-pat](https://github.com/npm-update-package/example-pat).
403
+
404
+ ### Use Yarn
356
405
 
357
406
  ```yaml
358
407
  name: npm-update-package
@@ -383,6 +432,8 @@ jobs:
383
432
  GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
384
433
  ```
385
434
 
435
+ See working example on [example-yarn](https://github.com/npm-update-package/example-yarn).
436
+
386
437
  ## Flow
387
438
 
388
439
  The following shows the process flow of npm-update-package.
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "0.52.0",
3
+ "version": "0.52.1",
4
4
  "description": "CLI tool for creating pull requests to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "0.52.0",
3
+ "version": "0.52.1",
4
4
  "description": "CLI tool for creating pull requests to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",