zx-bulk-release 1.16.2 → 1.17.2

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [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
+* docs: describe CLI options ([e744e97](https://github.com/semrel-extra/zx-bulk-release/commit/e744e97e8e5451ffff217283ad4e552f05073e7c))
+* docs: describe internal release flow ([e29bfc9](https://github.com/semrel-extra/zx-bulk-release/commit/e29bfc968a519d7c48b0475ad30c826bef17fb96))
+
+### Features
+* feat: introduce `--include-private` and `ignore` flags ([d029b62](https://github.com/semrel-extra/zx-bulk-release/commit/d029b6242da2e3c7fabaa5e24d61709b47e42b94))
+
 ## [1.16.2](https://github.com/semrel-extra/zx-bulk-release/compare/v1.16.1...v1.16.2) (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,7 @@
 * 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).
 
 ## Requirements
 * macOS / linux
@@ -22,10 +23,19 @@
 * 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]
 ```
+| Flag                | Description                | Default  |
+|---------------------|----------------------------|----------|
+| `--dry-run`         | Dry run mode               | `false`  |
+| `--ignore`          | Packages to ignore: `a, b` |          |
+| `--include-private` | Include private pkgs       | `false`  |
 
 ### JS API
 ```js
@@ -59,7 +69,7 @@ Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format
 
 ### Output
 
-[Readable and clear logs](https://github.com/semrel-extra/demo-zx-bulk-release/runs/7090161341?check_suite_focus=true#step:6:1)
+[Compact and clear logs](https://github.com/semrel-extra/demo-zx-bulk-release/runs/7090161341?check_suite_focus=true#step:6:1)
 
 ```shell
 Run npm_config_yes=true npx zx-bulk-release
@@ -99,6 +109,81 @@ zx-bulk-release
 ```
 
 ## Implementation notes
+### Flow
+```js
+try {
+  const {packages, queue, root} = await topo({cwd, flags})
+  console.log('queue:', queue)
+
+  for (let name of queue) {
+    const pkg = packages[name]
+
+    await analyze(pkg, packages, root)
+
+    if (pkg.changes.length === 0) continue
+
+    await build(pkg, packages)
+
+    if (flags.dryRun) continue
+
+    await publish(pkg)
+  }
+} catch (e) {
+  console.error(e)
+  throw e
+}
+```
+
+### `topo`
+[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`
+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})
+  await pushTag(pkg)
+  await pushMeta(pkg)
+  await pushChangelog(pkg)
+  await npmPublish(pkg)
+  await ghRelease(pkg)
+  await ghPages(pkg)
+}
+```
+
 ### 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
@@ -117,14 +202,14 @@ export const parseEnv = (env = process.env) => {
   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
 
   return {
-    ghUser: GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
-    ghToken: GH_TOKEN || GITHUB_TOKEN,
-    npmToken: NPM_TOKEN,
+    ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
+    ghToken:            GH_TOKEN || GITHUB_TOKEN,
+    npmToken:           NPM_TOKEN,
     // npmConfig suppresses npmToken
-    npmConfig: NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
-    npmRegistry: NPM_REGISTRY || 'https://registry.npmjs.org',
-    gitCommitterName: GIT_COMMITTER_NAME || 'Semrel Extra Bot',
-    gitCommitterEmail: GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
+    npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
+    npmRegistry:        NPM_REGISTRY || 'https://registry.npmjs.org',
+    gitCommitterName:   GIT_COMMITTER_NAME || 'Semrel Extra Bot',
+    gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
   }
 }
 ```

package/package.json

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

package/src/main/js/cli.js

@@ -2,5 +2,6 @@
 
 import {argv} from 'zx-extra'
 import {run} from './index.js'
+import {normalizeFlags} from './config.js';
 
-run({flags: argv})
+run({flags: normalizeFlags(argv)})

package/src/main/js/config.js

@@ -46,3 +46,6 @@ export const parseEnv = (env = process.env) => {
     gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
   }
 }
+
+const camelize = s => s.replace(/-./g, x=>x[1].toUpperCase())
+export const normalizeFlags = (flags = {}) => Object.entries(flags).reduce((acc, [k, v]) => ({...acc, [camelize(k)]: v}), {})

package/src/main/js/index.js

@@ -1,15 +1,13 @@
-import {topo} from '@semrel-extra/topo'
 import {analyze} from './analyze.js'
 import {publish} from './publish.js'
 import {build} from './build.js'
+import {topo} from './topo.js'
 
 export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} = {}) => {
   console.log('zx-bulk-release')
 
   try {
-  const {packages, queue, root} = await topo({cwd})
-  const dryRun = flags['dry-run'] || flags.dryRun
-
+  const {packages, queue, root} = await topo({cwd, flags})
   console.log('queue:', queue)
 
   for (let name of queue) {
@@ -21,7 +19,7 @@ export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} =
 
     await build(pkg, packages)
 
-    if (dryRun) continue
+    if (flags.dryRun) continue
 
     await publish(pkg)
   }

package/src/main/js/npm.js

@@ -50,10 +50,6 @@ export const npmPublish = (pkg) => ctx(async ($) => {
   await $`npm publish --no-git-tag-version --registry=${npmRegistry} --userconfig ${npmrc} --no-workspaces`
 })
 
-// NOTE registry-auth-token does not work with localhost:4873
-export const getAuthToken = (registry, npmrc) =>
-  (Object.entries(npmrc).find(([reg]) => reg.startsWith(registry.replace(/^https?/, ''))) || [])[1]
-
 // $`npm view ${name}@${version} dist.tarball`
 export const getTarballUrl = (registry, name, version) => `${registry}/${name}/-/${name.replace(/^.+(%2f|\/)/,'')}-${version}.tgz`
 
@@ -65,3 +61,7 @@ export const getBearerToken = async (npmRegistry, npmToken, npmConfig) => {
     : npmToken
   return `Bearer ${token}`
 }
+
+// NOTE registry-auth-token does not work with localhost:4873
+export const getAuthToken = (registry, npmrc) =>
+  (Object.entries(npmrc).find(([reg]) => reg.startsWith(registry.replace(/^https?/, ''))) || [])[1]

package/src/main/js/topo.js

@@ -0,0 +1,17 @@
+import {topo as _topo} from '@semrel-extra/topo'
+
+export const topo = async ({flags = {}, cwd} = {}) => {
+  const ignore = typeof flags.ignore === 'string'
+    ? flags.ignore.split(/\s*,\s*/)
+    : Array.isArray(flags.ignore)
+      ? flags.ignore
+      : []
+
+  const filter = flags.includePrivate
+    ? () => true
+    : ({manifest: {private: _private, name}}) =>
+      flags.includePrivate ? true : !_private &&
+      !ignore.includes(name)
+
+  return _topo({cwd, filter})
+}

package/src/test/js/topo.test.js

@@ -2,7 +2,7 @@ import {suite} from 'uvu'
 import * as assert from 'uvu/assert'
 import {fileURLToPath} from "node:url"
 import path from 'node:path'
-import {topo} from '@semrel-extra/topo'
+import {topo} from '../../main/js/topo.js'
 
 const test = suite('topo')
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
@@ -14,4 +14,9 @@ test('topo returns pkg info and release queue', async () => {
   assert.equal(queue, ['a', 'b', 'd', 'c'])
 })
 
+test('topo applies pkg filter', async () => {
+  const {nodes, queue} = await topo({cwd: path.resolve(fixtures, 'regular-monorepo'), flags: {ignore: 'b,c'}})
+  assert.equal(queue, ['a', 'd'])
+})
+
 test.run()