zx-bulk-release 2.2.5 → 2.2.7

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [2.2.7](https://github.com/semrel-extra/zx-bulk-release/compare/v2.2.6...v2.2.7) (2023-03-24)
+
+### Fixes & improvements
+* docs: describe more CLI flags ([6f7a053](https://github.com/semrel-extra/zx-bulk-release/commit/6f7a053ae2fe2da8fd71858b132ef4ac4d1456ad))
+* refactor: move `topo` to ctx builder ([6fec83c](https://github.com/semrel-extra/zx-bulk-release/commit/6fec83c10dd76feb93a3148eb2c032c6eaa902f1))
+
+## [2.2.6](https://github.com/semrel-extra/zx-bulk-release/compare/v2.2.5...v2.2.6) (2023-03-24)
+
+### Fixes & improvements
+* refactor: apply memoize to git utils ([ff8ff78](https://github.com/semrel-extra/zx-bulk-release/commit/ff8ff7840eb65171b7d69d45cafed944627bfd20))
+
 ## [2.2.5](https://github.com/semrel-extra/zx-bulk-release/compare/v2.2.4...v2.2.5) (2023-03-24)
 
 ### Fixes & improvements

package/README.md

@@ -18,10 +18,10 @@
 * No extra builds. The required deps are fetched from the pkg registry (`npmFetch` config opt).
 
 ## Roadmap
+* [x] Store release metrics to `meta`.
+* [ ] ~~Self-repair. Restore broken/missing metadata from external registries (npm, pypi, m2)~~. Tags should be the only source of truth
 * [ ] 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
@@ -37,11 +37,16 @@ yarn add zx-bulk-release
 ```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`  |
+| Flag                         | Description                                                    | Default          |
+|------------------------------|----------------------------------------------------------------|------------------|
+| `--ignore`                   | Packages to ignore: `a, b`                                     |                  |
+| `--include-private`          | Include `private` packages                                       | `false`          |
+| `--concurrency`              | `build/publish` threads limit                                  | `os.cpus.length` |
+| `--no-build`                 | Skip `buildCmd` invoke                                         |                  |
+| `--no-npm-fetch`             | Disable npm artifacts fetching                                 |                  |                      
+| `--dry-run` / `--no-publish` | Disable any publish logic                                      |                  |
+| `--report`                   | Persist release state to file                                  |                  |
+| `--debug`                    | Enable [zx](https://github.com/google/zx#verbose) verbose mode |                  |
 
 ### JS API
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zx-bulk-release",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": {

package/src/main/js/analyze.js

@@ -6,7 +6,7 @@ import {getCommits} from './git.js'
 
 export const analyze = async (pkg, packages) => {
   const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
-  const depsChanges = await updateDeps(pkg, packages)
+  const depsChanges = await updateDeps(pkg, pkg.context.packages)
   const changes = [...semanticChanges, ...depsChanges]
   const releaseType = getNextReleaseType(changes)
 

package/src/main/js/config.js

@@ -15,10 +15,10 @@ const CONFIG_FILES = [
 ]
 
 export const defaultConfig = {
-  cmd: 'yarn && yarn build && yarn test',
-  changelog: 'changelog',
-  npmFetch: true,
-  ghRelease: true,
+  cmd:        'yarn && yarn build && yarn test',
+  changelog:  'changelog',
+  npmFetch:   true,
+  ghRelease:  true,
   // npmPublish: true,
   // ghPages: 'gh-pages'
 }
@@ -38,10 +38,8 @@ export const normalizePkgConfig = (config, env) => ({
   }
 })
 
-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 {
+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, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = process.env) =>
+  ({
     ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
     ghToken:            GH_TOKEN || GITHUB_TOKEN,
     npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
@@ -49,7 +47,6 @@ export const parseEnv = (env = process.env) => {
     npmRegistry:        NPM_REGISTRY || 'https://registry.npmjs.org',
     gitCommitterName:   GIT_COMMITTER_NAME || 'Semrel Extra Bot',
     gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
-  }
-}
+  })
 
 export const normalizeFlags = (flags = {}) => Object.entries(flags).reduce((acc, [k, v]) => ({...acc, [camelize(k)]: v}), {})

package/src/main/js/git.js

@@ -1,14 +1,8 @@
 import {$, ctx, fs, path, tempy, copy} from 'zx-extra'
 import {log} from './log.js'
-import {keyByValue} from './util.js'
-
-const branches = {}
-export const fetchRepo = async ({cwd: _cwd, branch, origin: _origin, basicAuth}) => ctx(async ($) => {
-  const root = await getRoot(_cwd)
-  const id = `${root}:${branch}`
-
-  if (branches[id]) return branches[id]
+import {keyByValue, memoizeBy} from './util.js'
 
+export const fetchRepo = memoizeBy(async ({cwd: _cwd, branch, origin: _origin, basicAuth}) => ctx(async ($) => {
   const origin = _origin || (await getRepo(_cwd, {basicAuth})).repoAuthedUrl
   const cwd = tempy.temporaryDirectory()
   $.cwd = cwd
@@ -19,10 +13,9 @@ export const fetchRepo = async ({cwd: _cwd, branch, origin: _origin, basicAuth})
     await $`git init .`
     await $`git remote add origin ${origin}`
   }
-  branches[id] = cwd
 
-  return branches[id]
-})
+  return cwd
+}), async ({cwd, branch}) => `${await getRoot(cwd)}:${branch}`)
 
 export const pushCommit = async ({cwd, from, to, branch, origin, msg, ignoreFiles, files = [], basicAuth, gitCommitterEmail, gitCommitterName}) => ctx(async ($) => {
   let retries = 3
@@ -54,7 +47,6 @@ export const pushCommit = async ({cwd, from, to, branch, origin, msg, ignoreFile
     } catch (e) {
       retries -= 1
       log({level: 'error'})('git push failed', 'branch', branch, 'retries left', retries, e)
-      branches[keyByValue(branches, _cwd)] = null
 
       if (retries === 0) {
         throw e
@@ -63,11 +55,11 @@ export const pushCommit = async ({cwd, from, to, branch, origin, msg, ignoreFile
   }
 })
 
-const repos = {}
-export const getRepo = async (_cwd, {basicAuth} = {}) => {
-  const cwd = await getRoot(_cwd)
-  if (repos[cwd]) return repos[cwd]
+export const getRoot = async (cwd) => (await $.o({cwd})`git rev-parse --show-toplevel`).toString().trim()
 
+export const getSha = async (cwd) => (await $.o({cwd})`git rev-parse HEAD`).toString().trim()
+
+export const getRepo = memoizeBy(async (cwd, {basicAuth} = {}) => {
   const originUrl = await getOrigin(cwd)
   const [, , repoHost, repoName] = originUrl.replace(':', '/').replace(/\.git/, '').match(/.+(@|\/\/)([^/]+)\/(.+)$/) || []
   const repoPublicUrl = `https://${repoHost}/${repoName}`
@@ -75,29 +67,18 @@ export const getRepo = async (_cwd, {basicAuth} = {}) => {
     ? `https://${basicAuth}@${repoHost}/${repoName}.git`
     : originUrl
 
-  repos[cwd] = {
+  return {
     repoName,
     repoHost,
     repoPublicUrl,
     repoAuthedUrl,
     originUrl,
   }
+}, getRoot)
 
-  return repos[cwd]
-}
-
-const origins = {}
-export const getOrigin = async (cwd) => {
-  if (!origins[cwd]) {
-    origins[cwd] = $.o({cwd})`git config --get remote.origin.url`.then(r => r.toString().trim())
-  }
-
-  return origins[cwd]
-}
-
-export const getRoot = async (cwd) => (await $.o({cwd})`git rev-parse --show-toplevel`).toString().trim()
-
-export const getSha = async (cwd) => (await $.o({cwd})`git rev-parse HEAD`).toString().trim()
+export const getOrigin = memoizeBy(async (cwd) =>
+  $.o({cwd})`git config --get remote.origin.url`.then(r => r.toString().trim())
+)
 
 export const getCommits = async (cwd, from, to = 'HEAD') => ctx(async ($) => {
   const ref = from ? `${from}..${to}` : to

package/src/main/js/log.js

@@ -1,34 +1,28 @@
 import {$, fs} from 'zx-extra'
 import {get, set, tpl} from './util.js'
 
-export const log = (ctx) => {
-  if ($.report) {
-    return $.report.log(ctx)
-  }
-
-  return console.log
-}
+export const log = (ctx) =>
+  $.report
+    ? $.report.log(ctx)
+    : console.log
 
-export const createReport = ({logger = console, file = null} = {}) => ({
+export const createReport = ({logger = console, packages = {}, queue = [], flags} = {}) => ({
   logger,
-  file,
+  flags,
+  file: flags.report || flags.file,
   status: 'initial',
-  queue: [],
-  packages: {},
   events: [],
-  setPackages(packages) {
-    this.packages = Object.entries(packages).reduce((acc, [name, {manifest: {version}, absPath, relPath}]) => {
-      acc[name] = {
-        status: 'initial',
-        name,
-        version,
-        path: absPath,
-        relPath
-      }
-      return acc
-    }, {})
-    return this
-  },
+  queue,
+  packages: Object.entries(packages).reduce((acc, [name, {manifest: {version}, absPath, relPath}]) => {
+    acc[name] = {
+      status: 'initial',
+      name,
+      version,
+      path: absPath,
+      relPath
+    }
+    return acc
+  }, {}),
   get(key, pkgName) {
     return get(
       pkgName ? this.packages[pkgName] : this,

package/src/main/js/processor.js

@@ -13,23 +13,20 @@ import {fetchPkg, npmPublish} from './npm.js'
 import {memoizeBy, tpl} from './util.js'
 
 export const run = async ({cwd = process.cwd(), env, flags = {}} = {}) => within(async () => {
-  const {report, build, publish} = createContext(flags, env)
+  const context = await createContext({flags, env, cwd})
+  const {report, build, publish, packages, queue, prev, graphs} = context
 
-  report.log()('zx-bulk-release')
+  report
+    .log()('zx-bulk-release')
+    .log()('queue:', queue)
+    .log()('graphs', graphs)
 
   try {
-    const {packages, queue, root, prev, graphs} = await topo({cwd, flags})
-    report
-      .log()('queue:', queue)
-      .log()('graphs', graphs)
-      .set('queue', queue)
-      .setPackages(packages)
-
     await traverseQueue({queue, prev, async cb(name) {
       report.setStatus('analyzing', name)
       const pkg = packages[name]
-      await contextify(pkg, packages, root)
-      await analyze(pkg, packages)
+      await contextify(pkg, context)
+      await analyze(pkg)
       report
         .set('config', pkg.config, name)
         .set('version', pkg.version, name)
@@ -47,17 +44,14 @@ export const run = async ({cwd = process.cwd(), env, flags = {}} = {}) => within
         report.setStatus('skipped', name)
         return
       }
-
-      report.setStatus('building', name)
-      await build(pkg, packages)
-
-      if (flags.dryRun) {
-        report.setStatus('success', name)
-        return
+      if (!flags.noBuild) {
+        report.setStatus('building', name)
+        await build(pkg)
+      }
+      if (!flags.dryRun && !flags.noPublish) {
+        report.setStatus('publishing', name)
+        await publish(pkg)
       }
-
-      report.setStatus('publishing', name)
-      await publish(pkg)
 
       report.setStatus('success', name)
     }})
@@ -78,30 +72,35 @@ export const runCmd = async (pkg, name) => {
 
   if (cmd) {
     log({pkg})(`run ${name} '${cmd}'`)
-    await $.o({cwd: pkg.absPath, quote: v => v, preferLocal: true})`${cmd}`
+    return $.o({cwd: pkg.absPath, quote: v => v, preferLocal: true})`${cmd}`
   }
 }
 
-const createContext = (flags, env) => {
-  const report = createReport({file: flags.report})
-  const _runCmd = queuefy(runCmd, flags.concurrency || os.cpus().length)
-  const _build = memoizeBy((pkg, packages) => build(pkg, packages, _runCmd, _build))
-  const _publish = memoizeBy((pkg) => publish(pkg, _runCmd))
+const createContext = async ({flags, env, cwd}) => {
+  const { packages, queue, root, prev, graphs } = await topo({cwd, flags})
+  const report =    createReport({packages, queue, flags})
+  const run =       queuefy(runCmd, flags.concurrency || os.cpus().length)
+  const _build =    memoizeBy((pkg) => build(pkg, run, _build, flags))
+  const _publish =  memoizeBy((pkg) => publish(pkg, run))
 
-  $.report = report
-  $.env = {...process.env, ...env}
-  $.verbose = !!(flags.debug || $.env.DEBUG ) || $.verbose
+  $.report =        report
+  $.env =           {...process.env, ...env}
+  $.verbose =       !!(flags.debug || $.env.DEBUG ) || $.verbose
 
   return {
     report,
-    runCmd: _runCmd,
     build: _build,
-    publish: _publish
+    publish: _publish,
+    packages,
+    root,
+    queue,
+    prev,
+    graphs
   }
 }
 
 // Inspired by https://docs.github.com/en/actions/learn-github-actions/contexts
-const contextify = async (pkg, packages, root) => {
+const contextify = async (pkg, {packages, root}) => {
   pkg.config = await getPkgConfig(pkg.absPath, root.absPath)
   pkg.latest = await getLatest(pkg)
   pkg.context = {
@@ -114,13 +113,12 @@ const contextify = async (pkg, packages, root) => {
   }
 }
 
-const build = async (pkg, packages, run = runCmd, self = build) => within(async () => {
+const build = async (pkg, run = runCmd, self = build, flags = {}) => within(async () => {
   $.scope = pkg.name
-  if (pkg.built) return
 
   await Promise.all([
-    traverseDeps(pkg, packages, async (_, {pkg}) => self(pkg, packages, run, self)),
-    pkg.changes.length === 0 && pkg.config.npmFetch
+    traverseDeps(pkg, pkg.context.packages, async (_, {pkg}) => self(pkg, run, self, flags)),
+    pkg.changes.length === 0 && pkg.config.npmFetch && !flags.noNpmFetch
       ? fetchPkg(pkg)
       : Promise.resolve()
   ])
@@ -146,4 +144,6 @@ const publish = async (pkg, run = runCmd) => within(async () => {
     ghPages(pkg),
     run(pkg, 'publishCmd')
   ])
+
+  pkg.published = true
 })

package/src/main/js/util.js

@@ -30,23 +30,10 @@ export const set = (obj, path, value) => {
 
 export const msgJoin = (rest, context, def) => tpl(rest.filter(Boolean).join(' ') || def, context)
 
-export const getPromise = () => {
-    let resolve, reject
-    const promise = new Promise((...args) => {
-        [resolve, reject] = args
-    })
-
-    return {
-        resolve,
-        reject,
-        promise,
-    }
-}
-
 export const keyByValue = (obj, value) => Object.keys(obj).find((key) => obj[key] === value)
 
-export const memoizeBy = (fn, memo = new Map(), getKey = v => v) => (...args) => {
-  const key = getKey(...args)
+export const memoizeBy = (fn, getKey = v => v, memo = new Map()) => async (...args) => {
+  const key = await getKey(...args)
   if (memo.has(key)) {
     return memo.get(key)
   }