zx-bulk-release 1.1.0 → 1.1.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.
- package/CHANGELOG.md +5 -0
- package/README.md +18 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
## [1.1.1](https://github.com/semrel-extra/zx-bulk-release/compare/v1.1.0...v1.1.1) (2022-06-18)
|
|
2
|
+
|
|
3
|
+
### Fixes & improvements
|
|
4
|
+
* docs: mention js api ([06cda98](https://github.com/semrel-extra/zx-bulk-release/commit/06cda9869b96fc2aca5d278f45d5e733e2cc23ab))
|
|
5
|
+
|
|
1
6
|
## [1.1.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.0.3...v1.1.0) (2022-06-18)
|
|
2
7
|
|
|
3
8
|
### Features
|
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ GH_TOKEN=foo NPM_TOKEN=bar zx-extra zx-bulk-release.mjs
|
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
## Roadmap
|
|
17
|
-
* [x] [
|
|
17
|
+
* [x] [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) trigger semantic releases.
|
|
18
18
|
* [x] Predictable [toposort](https://githib.com/semrel-extra/topo)-driven flow.
|
|
19
19
|
* [x] No blocking (no release commits).
|
|
20
20
|
* [ ] Changelogs, docs, bundles go to: release assets and/or meta branch.
|
|
@@ -24,9 +24,24 @@ GH_TOKEN=foo NPM_TOKEN=bar zx-extra zx-bulk-release.mjs
|
|
|
24
24
|
[Lerna](https://github.com/lerna/lerna) tags (like `@pkg/name@v1.0.0-beta.0`) are suitable for monorepos, but they don’t follow [semver spec](https://semver.org/). Therefore, we propose another contract:
|
|
25
25
|
```js
|
|
26
26
|
'2022.6.13-optional-org.pkg-name.v1.0.0-beta.1+sha.1-f0'
|
|
27
|
-
// date name version format
|
|
27
|
+
// date name version format
|
|
28
|
+
```
|
|
29
|
+
Note, [npm-package-name charset](https://www.npmjs.com/package/validate-npm-package-name) is wider than [semver](https://semver.org/spec/v2.0.0.html#spec-item-4), so we need a pinch of [base64url magic](https://stackoverflow.com/questions/55389211/string-based-data-encoding-base64-vs-base64url) for some cases.
|
|
30
|
+
```js
|
|
31
|
+
'2022.6.13-examplecom.v1.0.0.ZXhhbXBsZS5jb20-f1'
|
|
32
|
+
// date name ver b64 format
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## JS API
|
|
36
|
+
```js
|
|
37
|
+
import { run } from 'zx-bulk-release'
|
|
38
|
+
|
|
39
|
+
const cwd = '/foo/bar' // Defaults to process.cwd()
|
|
40
|
+
const env = { GH_TOKEN: 'foo', NPM_TOKEN: 'bar' } // Defaults to process.env
|
|
41
|
+
const flags = {dryRun: true}
|
|
42
|
+
|
|
43
|
+
await run({cwd, flags, env})
|
|
28
44
|
```
|
|
29
|
-
Note, [npm-package-name charset](https://www.npmjs.com/package/validate-npm-package-name) is wider than [semver](https://semver.org/spec/v2.0.0.html#spec-item-4), so we need a pinch of [base64url magic](https://stackoverflow.com/questions/55389211/string-based-data-encoding-base64-vs-base64url).
|
|
30
45
|
|
|
31
46
|
## References
|
|
32
47
|
* [semrel-extra/zx-semrel](https://github.com/semrel-extra/zx-semrel)
|