zx-bulk-release 1.17.0 → 1.17.3

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.17.3](https://github.com/semrel-extra/zx-bulk-release/compare/v1.17.2...v1.17.3) (2022-06-29)
+
+### Fixes & improvements
+* docs: add roadmap ([185a12d](https://github.com/semrel-extra/zx-bulk-release/commit/185a12d8956c3e274035b863682afee3bd64ccb7))
+
+## [1.17.2](https://github.com/semrel-extra/zx-bulk-release/compare/v1.17.1...v1.17.2) (2022-06-28)
+
+### Fixes & improvements
+* docs: add npm badge ([f63dfe3](https://github.com/semrel-extra/zx-bulk-release/commit/f63dfe338208641a8edd910b81e320deeed2446c))
+
+## [1.17.1](https://github.com/semrel-extra/zx-bulk-release/compare/v1.17.0...v1.17.1) (2022-06-28)
+
+### Fixes & improvements
+* docs: describe `analyze` step ([ae611ad](https://github.com/semrel-extra/zx-bulk-release/commit/ae611ada7709d9f9fa72d20f39e74ebe05353a2d))
+
 ## [1.17.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.16.2...v1.17.0) (2022-06-28)
 
 ### Fixes & improvements

package/README.md

@@ -4,6 +4,7 @@
 [![CI](https://github.com/semrel-extra/zx-bulk-release/workflows/CI/badge.svg)](https://github.com/semrel-extra/zx-bulk-release/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/bb94e929b1b6430781b5/maintainability)](https://codeclimate.com/github/semrel-extra/zx-bulk-release/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/bb94e929b1b6430781b5/test_coverage)](https://codeclimate.com/github/semrel-extra/zx-bulk-release/test_coverage)
+[![npm (tag)](https://img.shields.io/npm/v/zx-bulk-release)](https://www.npmjs.com/package/zx-bulk-release)
 
 🚧 Work in progress. Early access preview
 
@@ -14,7 +15,13 @@
 * No default branch blocking (no release commits).
 * Pkg changelogs go to `changelog` branch (configurable).
 * Docs are published to `gh-pages` branch (configurable).
-* No extra builds. The required deps are fetched from the pkg registry (`npmFetch` flag).
+* No extra builds. The required deps are fetched from the pkg registry (`npmFetch` config opt).
+
+## Roadmap
+* [ ] Multistack. Add support for java/kt/py.
+* [ ] Self-repair. Restore broken/missing metadata from external registries (npm, pypi, m2).
+* [ ] Semaphore. Let several release agents to serve the monorepo at the same time.
+* [ ] Stats. Store release metrics to `meta`.
 
 ## Requirements
 * macOS / linux
@@ -22,6 +29,10 @@
 * npm >=7 / yarn >= 3
 
 ## Usage
+### Install
+```shell
+yarn add zx-bulk-release
+```
 ### CLI
 ```shell
 GH_TOKEN=ghtoken GH_USER=username NPM_TOKEN=npmtoken npx zx-bulk-release [opts]
@@ -130,14 +141,43 @@ try {
 ```
 
 ### `topo`
-[Toposort](https://github.com/semrel-extra/topo) is used to order the pkgs to be released.
+[Toposort](https://github.com/semrel-extra/topo) is used to resolve the pkg release queue.
 By default, it omits the packages marked as `private`. You can override this by setting the `--include-private` flag.
 
 ### `analyze`
 Determines pkg changes, release type, next version etc.
+```js
+export const analyze = async (pkg, packages, root) => {
+  pkg.config = await getConfig(pkg.absPath, root.absPath)
+  pkg.latest = await getLatest(pkg)
+
+  const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
+  const depsChanges = await updateDeps(pkg, packages)
+  const changes = [...semanticChanges, ...depsChanges]
+
+  pkg.changes = changes
+  pkg.version = resolvePkgVersion(changes, pkg.latest.tag?.version || pkg.manifest.version)
+  pkg.manifest.version = pkg.version
+
+  console.log(`[${pkg.name}] semantic changes`, changes)
+}
+```
 
 ### `build`
-Building pkg assets: bundles, docs, etc.
+Applies `config.cmd` to build pkg assets: bundles, docs, etc.
+```js
+export const build = async (pkg, packages) => {
+  // ...
+  if (!pkg.fetched && config.cmd) {
+    console.log(`[${pkg.name}] run cmd '${config.cmd}'`)
+    await $.o({cwd: pkg.absPath, quote: v => v})`${config.cmd}`
+  }
+  // ...
+}
+```
+
+### `publish`
+Publish the pkg to git, npm, gh-pages, gh-release, etc.
 ```js
 export const publish = async (pkg) => {
   await fs.writeJson(pkg.manifestPath, pkg.manifest, {spaces: 2})
@@ -150,9 +190,6 @@ export const publish = async (pkg) => {
 }
 ```
 
-### `publish`
-Publish the pkg to git, npm, gh-pages, gh-release, etc.
-
 ### Tags
 [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:
 ```js
@@ -207,6 +244,7 @@ Each release projects its result into the `meta` branch.
 * [conventional-changelog/releaser-tools](https://github.com/conventional-changelog/releaser-tools)
 * [pmowrer/semantic-release-monorepo](https://github.com/pmowrer/semantic-release-monorepo)
 * [jscutlery/semver](https://github.com/jscutlery/semver)
+* [microsoft/rushstack](https://github.com/microsoft/rushstack)
 * [tophat/monodeploy](https://github.com/tophat/monodeploy)
 * [intuit/auto](https://github.com/intuit/auto)
 * [vercel/turborepo](https://github.com/vercel/turborepo)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zx-bulk-release",
-  "version": "1.17.0",
+  "version": "1.17.3",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": "./src/main/js/index.js",