bulk-release 2.6.0 → 2.6.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/CHANGELOG.md +5 -0
  2. package/README.md +65 -77
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,8 @@
1
+ ## [2.6.1](https://github.com/semrel-extra/zx-bulk-release/compare/v2.6.0...v2.6.1) (2023-04-21)
2
+
3
+ ### Fixes & improvements
4
+ * docs: readme struct edits, mention `wget` and `git` as requirements ([2f76f12](https://github.com/semrel-extra/zx-bulk-release/commit/2f76f12b142a700dd53045fc4d268d6d8e64b721))
5
+
1
6
  ## [2.6.0](https://github.com/semrel-extra/zx-bulk-release/compare/v2.5.3...v2.6.0) (2023-04-21)
2
7
 
3
8
  ### Features
package/README.md CHANGED
@@ -25,6 +25,9 @@
25
25
  * macOS / linux
26
26
  * Node.js >= 16.0.0
27
27
  * npm >=7 / yarn >= 3
28
+ * wget
29
+ * tar
30
+ * git
28
31
 
29
32
  ## Usage
30
33
  ### Install
@@ -63,23 +66,9 @@ await run({
63
66
  })
64
67
  ```
65
68
 
66
- ### ENV
67
- ```ts
68
- export const parseEnv = ({GH_USER, GH_USERNAME, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, NPM_PROVENANCE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = process.env) =>
69
- ({
70
- ghUser: GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
71
- ghToken: GH_TOKEN || GITHUB_TOKEN,
72
- npmConfig: NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
73
- npmToken: NPM_TOKEN,
74
- npmProvenance: NPM_PROVENANCE,
75
- npmRegistry: NPM_REGISTRY || 'https://registry.npmjs.org',
76
- gitCommitterName: GIT_COMMITTER_NAME || 'Semrel Extra Bot',
77
- gitCommitterEmail: GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
78
- })
79
- ```
80
-
81
- ### Config
82
- Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format: `.releaserc`, `.release.json`, `.release.yaml`, etc.
69
+ ## Config
70
+ ### cosmiconfig
71
+ Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format: `.releaserc`, `.release.json`, `.release.yaml`, etc in the package root or in the repo root dir.
83
72
  ```json
84
73
  {
85
74
  "cmd": "yarn && yarn build && yarn test",
@@ -89,51 +78,29 @@ Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format
89
78
  }
90
79
  ```
91
80
 
92
- ### Demo
93
- * [demo-zx-bulk-release](https://github.com/semrel-extra/demo-zx-bulk-release)
94
- * [qiwi/pijma](https://github.com/qiwi/pijma)
95
-
96
- ### Output
97
-
98
- [Compact and clear logs](https://github.com/semrel-extra/demo-zx-bulk-release/runs/7090161341?check_suite_focus=true#step:6:1)
81
+ ### env vars
82
+ ```js
83
+ export const parseEnv = (env = process.env) => {
84
+ const {GH_USER, GH_USERNAME, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, NPM_PROVENANCE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = env
99
85
 
100
- ```shell
101
- Run npm_config_yes=true npx zx-bulk-release
102
- zx-bulk-release
103
- [@semrel-extra/zxbr-test-a] semantic changes [
104
- {
105
- group: 'Fixes & improvements',
106
- releaseType: 'patch',
107
- change: 'fix(a): random',
108
- subj: 'fix(a): random',
109
- body: '',
110
- short: '6ff25bd',
111
- hash: '6ff25bd421755b929ef2b58f35c727670fd93849'
112
- }
113
- ]
114
- [@semrel-extra/zxbr-test-a] run cmd 'yarn && yarn build && yarn test'
115
- [@semrel-extra/zxbr-test-a] push release tag 2022.6.27-semrel-extra.zxbr-test-a.1.8.1-f0
116
- [@semrel-extra/zxbr-test-a] push artifact to branch 'meta'
117
- [@semrel-extra/zxbr-test-a] push changelog
118
- [@semrel-extra/zxbr-test-a] publish npm package @semrel-extra/zxbr-test-a 1.8.1 to https://registry.npmjs.org
119
- [@semrel-extra/zxbr-test-a] create gh release
120
- [@semrel-extra/zxbr-test-b] semantic changes [
121
- {
122
- group: 'Dependencies',
123
- releaseType: 'patch',
124
- change: 'perf',
125
- subj: 'perf: @semrel-extra/zxbr-test-a updated to 1.8.1'
86
+ return {
87
+ ghUser: GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
88
+ ghToken: GH_TOKEN || GITHUB_TOKEN,
89
+ npmToken: NPM_TOKEN,
90
+ // npmConfig suppresses npmToken
91
+ npmConfig: NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
92
+ npmRegistry: NPM_REGISTRY || 'https://registry.npmjs.org',
93
+ npmProvenance: NPM_PROVENANCE,
94
+ gitCommitterName: GIT_COMMITTER_NAME || 'Semrel Extra Bot',
95
+ gitCommitterEmail: GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
126
96
  }
127
- ]
128
- [@semrel-extra/zxbr-test-b] run cmd 'yarn && yarn build && yarn test'
129
- [@semrel-extra/zxbr-test-b] push release tag 2022.6.27-semrel-extra.zxbr-test-b.1.3.5-f0
130
- [@semrel-extra/zxbr-test-b] push artifact to branch 'meta'
131
- [@semrel-extra/zxbr-test-b] push changelog
132
- [@semrel-extra/zxbr-test-b] publish npm package @semrel-extra/zxbr-test-b 1.3.5 to https://registry.npmjs.org
133
- [@semrel-extra/zxbr-test-b] create gh release
134
- [@semrel-extra/zxbr-test-d] semantic changes [
97
+ }
135
98
  ```
136
99
 
100
+ ## Demo
101
+ * [demo-zx-bulk-release](https://github.com/semrel-extra/demo-zx-bulk-release)
102
+ * [qiwi/pijma](https://github.com/qiwi/pijma)
103
+
137
104
  ## Implementation notes
138
105
  ### Flow
139
106
  ```js
@@ -223,25 +190,6 @@ Note, [npm-package-name charset](https://www.npmjs.com/package/validate-npm-pack
223
190
  // date name ver b64 format
224
191
  ```
225
192
 
226
- ### env vars
227
-
228
- ```js
229
- export const parseEnv = (env = process.env) => {
230
- const {GH_USER, GH_USERNAME, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = env
231
-
232
- return {
233
- ghUser: GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
234
- ghToken: GH_TOKEN || GITHUB_TOKEN,
235
- npmToken: NPM_TOKEN,
236
- // npmConfig suppresses npmToken
237
- npmConfig: NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
238
- npmRegistry: NPM_REGISTRY || 'https://registry.npmjs.org',
239
- gitCommitterName: GIT_COMMITTER_NAME || 'Semrel Extra Bot',
240
- gitCommitterEmail: GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
241
- }
242
- }
243
- ```
244
-
245
193
  ### Meta
246
194
 
247
195
  Each release stores its result into the `meta` branch.
@@ -305,6 +253,46 @@ Release process state is reported to the console and to a file if `--report` fla
305
253
  }
306
254
  ```
307
255
 
256
+ ### Output
257
+ [Compact and clear logs](https://github.com/semrel-extra/demo-zx-bulk-release/runs/7090161341?check_suite_focus=true#step:6:1)
258
+
259
+ ```shell
260
+ Run npm_config_yes=true npx zx-bulk-release
261
+ zx-bulk-release
262
+ [@semrel-extra/zxbr-test-a] semantic changes [
263
+ {
264
+ group: 'Fixes & improvements',
265
+ releaseType: 'patch',
266
+ change: 'fix(a): random',
267
+ subj: 'fix(a): random',
268
+ body: '',
269
+ short: '6ff25bd',
270
+ hash: '6ff25bd421755b929ef2b58f35c727670fd93849'
271
+ }
272
+ ]
273
+ [@semrel-extra/zxbr-test-a] run cmd 'yarn && yarn build && yarn test'
274
+ [@semrel-extra/zxbr-test-a] push release tag 2022.6.27-semrel-extra.zxbr-test-a.1.8.1-f0
275
+ [@semrel-extra/zxbr-test-a] push artifact to branch 'meta'
276
+ [@semrel-extra/zxbr-test-a] push changelog
277
+ [@semrel-extra/zxbr-test-a] publish npm package @semrel-extra/zxbr-test-a 1.8.1 to https://registry.npmjs.org
278
+ [@semrel-extra/zxbr-test-a] create gh release
279
+ [@semrel-extra/zxbr-test-b] semantic changes [
280
+ {
281
+ group: 'Dependencies',
282
+ releaseType: 'patch',
283
+ change: 'perf',
284
+ subj: 'perf: @semrel-extra/zxbr-test-a updated to 1.8.1'
285
+ }
286
+ ]
287
+ [@semrel-extra/zxbr-test-b] run cmd 'yarn && yarn build && yarn test'
288
+ [@semrel-extra/zxbr-test-b] push release tag 2022.6.27-semrel-extra.zxbr-test-b.1.3.5-f0
289
+ [@semrel-extra/zxbr-test-b] push artifact to branch 'meta'
290
+ [@semrel-extra/zxbr-test-b] push changelog
291
+ [@semrel-extra/zxbr-test-b] publish npm package @semrel-extra/zxbr-test-b 1.3.5 to https://registry.npmjs.org
292
+ [@semrel-extra/zxbr-test-b] create gh release
293
+ [@semrel-extra/zxbr-test-d] semantic changes [
294
+ ```
295
+
308
296
  ## References
309
297
  * [semrel-extra/zx-semrel](https://github.com/semrel-extra/zx-semrel)
310
298
  * [dhoulb/multi-semantic-release](https://github.com/dhoulb/multi-semantic-release)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bulk-release",
3
3
  "alias": "bulk-release",
4
- "version": "2.6.0",
4
+ "version": "2.6.1",
5
5
  "description": "zx-based alternative for multi-semantic-release",
6
6
  "type": "module",
7
7
  "exports": {