zx-bulk-release 1.22.3 → 1.23.0

package/.github/workflows/ci.yml

@@ -101,7 +101,7 @@ jobs:
         run: yarn docs
 
       - name: Codeclimate
-        uses: paambaati/codeclimate-action@v3.0.0
+        uses: paambaati/codeclimate-action@v3.1.0
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         with:

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.23.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.22.3...v1.23.0) (2022-10-14)
+
+### Features
+* feat: introduce reports ([443102c](https://github.com/semrel-extra/zx-bulk-release/commit/443102c6395adabef63e433ec1136d30dbe8fff4))
+
+### Fixes & improvements
+* refactor: introduce internal logger ([ede8d6d](https://github.com/semrel-extra/zx-bulk-release/commit/ede8d6df3612654f3d6e9d5997f1b579c8149f2b))
+* perf: up depx ([372bab2](https://github.com/semrel-extra/zx-bulk-release/commit/372bab2639d8feabaf1153e2cb0576838edb556f))
+
 ## [1.22.3](https://github.com/semrel-extra/zx-bulk-release/compare/v1.22.2...v1.22.3) (2022-08-25)
 
 ### Fixes & improvements

package/README.md

@@ -203,6 +203,7 @@ Note, [npm-package-name charset](https://www.npmjs.com/package/validate-npm-pack
 ```
 
 ### env vars
+
 ```js
 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
@@ -222,7 +223,7 @@ export const parseEnv = (env = process.env) => {
 
 ### Meta
 
-Each release projects its result into the `meta` branch.  
+Each release stores its result into the `meta` branch.  
 `2022-6-26-semrel-extra-zxbr-test-c-1-3-1-f0.json`
 ```json
 {
@@ -237,6 +238,29 @@ Each release projects its result into the `meta` branch.
 }
 ```
 
+### Report
+
+Release process state is reported to the console and `release-report.json` if `report` flag set to `true`.
+```json
+{
+  status: 'success' | 'failure' | 'pending',
+  error: string | null
+  queue: ['a', 'b', 'c', 'd'],
+  packages: [
+      name: string,
+      version: string,
+      path: string
+      config: {},
+      changes: [],
+      tag: string | null,
+      version: string,
+      releaseType: string | null,
+      prevVersion: string | null,
+    }
+  }]
+}
+```
+
 ## References
 * [semrel-extra/zx-semrel](https://github.com/semrel-extra/zx-semrel)
 * [dhoulb/multi-semantic-release](https://github.com/dhoulb/multi-semantic-release)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zx-bulk-release",
-  "version": "1.22.3",
+  "version": "1.23.0",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": "./src/main/js/index.js",
@@ -13,12 +13,12 @@
   "dependencies": {
     "@semrel-extra/topo": "^1.4.3",
     "cosmiconfig": "^7.0.1",
-    "zx-extra": "^2.5.1"
+    "zx-extra": "^2.5.2"
   },
   "devDependencies": {
     "c8": "^7.12.0",
     "uvu": "^0.5.6",
-    "verdaccio": "^5.14.0"
+    "verdaccio": "^5.15.4"
   },
   "publishConfig": {
     "access": "public"

package/src/main/js/analyze.js

@@ -1,16 +1,19 @@
 import {ctx, semver} from 'zx-extra'
 import {updateDeps} from './deps.js'
+import {log} from './util.js'
 
 export const analyze = async (pkg, packages) => {
   const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
   const depsChanges = await updateDeps(pkg, packages)
   const changes = [...semanticChanges, ...depsChanges]
+  const releaseType = getNextReleaseType(changes)
 
   pkg.changes = changes
-  pkg.version = resolvePkgVersion(changes, pkg.latest.tag?.version || pkg.manifest.version)
+  pkg.releaseType = releaseType
+  pkg.version = resolvePkgVersion(releaseType, pkg.latest.tag?.version || pkg.manifest.version)
   pkg.manifest.version = pkg.version
 
-  console.log(`[${pkg.name}] semantic changes`, changes)
+  log({pkg})('semantic changes', changes)
 }
 
 export const releaseSeverityOrder = ['major', 'minor', 'patch']
@@ -61,17 +64,17 @@ export const getSemanticChanges = async (cwd, since) => {
   return semanticChanges
 }
 
-export const getNextReleaseType = (changes) => releaseSeverityOrder.find(type => changes.find(({releaseType}) => type === releaseType))
+export const getNextReleaseType = (changes) => changes.length
+  ? releaseSeverityOrder.find(type => changes.find(({releaseType}) => type === releaseType))
+  : null
 
-export const getNextVersion = (changes, prevVersion) => {
+export const getNextVersion = (releaseType, prevVersion) => {
   if (!prevVersion) return '1.0.0'
 
-  const releaseType = getNextReleaseType(changes)
-
   return semver.inc(prevVersion, releaseType)
 }
 
-export const resolvePkgVersion = (changes, prevVersion) =>
-  changes.length > 0
-    ? getNextVersion(changes, prevVersion)
+export const resolvePkgVersion = (releaseType, prevVersion) =>
+  releaseType
+    ? getNextVersion(releaseType, prevVersion)
     : prevVersion || null

package/src/main/js/build.js

@@ -12,7 +12,7 @@ export const build = async (pkg, packages) => {
   if (pkg.changes.length === 0 && config.npmFetch) await fetchPkg(pkg)
 
   if (!pkg.fetched && config.buildCmd) {
-    await await runHook(pkg, 'buildCmd')
+    await runHook(pkg, 'buildCmd')
   }
 
   pkg.built = true

package/src/main/js/index.js

@@ -1,36 +1,60 @@
+import {within, $} from 'zx-extra'
 import {analyze} from './analyze.js'
 import {publish} from './publish.js'
 import {build} from './build.js'
 import {contextify} from './contextify.js'
 import {topo} from './topo.js'
-import {within, $} from 'zx-extra'
+import {createReporter, log} from './util.js';
 
 export const run = async ({cwd = process.cwd(), env, flags = {}} = {}) => within(async () => {
-  console.log('zx-bulk-release')
+  const reporter = $.r = createReporter(flags.report)
   $.env = {...process.env, ...env}
   $.verbose = !!(flags.debug || $.env.DEBUG ) || $.verbose
+  log()('zx-bulk-release')
 
   try {
   const {packages, queue, root} = await topo({cwd, flags})
-  console.log('queue:', queue)
+  log()('queue:', queue)
+
+  reporter.setQueue(queue, packages)
+  reporter.setStatus('pending')
 
   for (let name of queue) {
     const pkg = packages[name]
 
+    reporter.setStatus('analyzing', name)
     await contextify(pkg, packages, root)
     await analyze(pkg, packages)
+    reporter.setState('config', pkg.config, name)
+    reporter.setState('version', pkg.version, name)
+    reporter.setState('prevVersion', pkg.latest.tag?.version || pkg.manifest.version, name)
+    reporter.setState('releaseType', pkg.releaseType, name)
 
-    if (pkg.changes.length === 0) continue
+    if (!pkg.releaseType) {
+      reporter.setStatus('skipped', name)
+      continue
+    }
 
+    reporter.setStatus('building', name)
     await build(pkg, packages)
+    reporter.setStatus('')
 
-    if (flags.dryRun) continue
+    if (flags.dryRun) {
+      reporter.setStatus('success', name)
+      continue
+    }
 
+    reporter.setStatus('publishing', name)
     await publish(pkg)
+
+    reporter.setStatus('success', name)
   }
   } catch (e) {
-    console.error(e)
+    log({level: 'error'})(e)
+    reporter.setState('error', e)
+    reporter.setStatus('failure')
     throw e
   }
-  console.log('Great success!')
+  reporter.setStatus('success')
+  log()('Great success!')
 })

package/src/main/js/npm.js

@@ -1,4 +1,5 @@
 import {parseEnv} from './config.js'
+import {log} from './util.js'
 import {$, ctx, fs, path, tempy, copy, INI, fetch} from 'zx-extra'
 
 export const fetchPkg = async (pkg, {env = $.env} = {}) => {
@@ -13,9 +14,9 @@ export const fetchPkg = async (pkg, {env = $.env} = {}) => {
     await copy({from: ['**/*', '!package.json'], to: cwd, baseFrom: `${temp}/package`})
 
     pkg.fetched = true
-    console.log(`[${pkg.name}] fetched '${pkg.name}@${pkg.version}'`)
+    log({pkg})(`fetched '${pkg.name}@${pkg.version}'`)
   } catch (e) {
-    console.log(`[${pkg.name}] fetching '${pkg.name}@${pkg.version}' failed`, e)
+    log({pkg})(`fetching '${pkg.name}@${pkg.version}' failed`, e)
   }
 }
 
@@ -41,7 +42,7 @@ export const npmPublish = (pkg) => ctx(async ($) => {
   const {npmRegistry, npmToken, npmConfig} = parseEnv($.env)
   const npmrc = npmConfig ? npmConfig : path.resolve(cwd, '.npmrc')
 
-  console.log(`[${name}] publish npm package ${name} ${version} to ${npmRegistry}`)
+  log({pkg})(`publish npm package ${name} ${version} to ${npmRegistry}`)
   $.cwd = cwd
   if (!npmConfig) {
     await $.raw`echo ${npmRegistry.replace(/https?:/, '')}/:_authToken=${npmToken} >> ${npmrc}`

package/src/main/js/publish.js

@@ -3,7 +3,7 @@ import {fs, path, $} from 'zx-extra'
 import {push, fetch, parseRepo} from './repo.js'
 import {parseEnv} from './config.js'
 import {fetchManifest, npmPublish} from './npm.js'
-import {restJoin, runHook} from './util.js'
+import {restJoin, runHook, log} from './util.js'
 
 export const publish = async (pkg) => {
   await fs.writeJson(pkg.manifestPath, pkg.manifest, {spaces: 2})
@@ -17,7 +17,7 @@ export const publish = async (pkg) => {
 }
 
 export const pushMeta = async (pkg) => {
-  console.log(`[${pkg.name}] push artifact to branch 'meta'`)
+  log({pkg})('push artifact to branch \'meta\'')
 
   const {name, version, absPath: cwd} = pkg
   const tag = formatTag({name, version})
@@ -41,7 +41,7 @@ export const pushMeta = async (pkg) => {
 }
 
 export const ghRelease = async (pkg) => {
-  console.log(`[${pkg.name}] create gh release`)
+  log({pkg})(`create gh release`)
 
   const {ghToken} = parseEnv($.env)
   if (!ghToken) return null
@@ -63,7 +63,7 @@ const pushChangelog = async (pkg) => {
   const {config: {changelog: opts}} = pkg
   if (!opts) return
 
-  console.log(`[${pkg.name}] push changelog`)
+  log({pkg})('push changelog')
   const [branch = 'changelog', file = `${pkg.name.replace(/[^a-z0-9-]/ig, '')}-changelog.md`, ..._msg] = typeof opts === 'string'
     ? opts.split(' ')
     : [opts.branch, opts.file, opts.msg]
@@ -105,7 +105,7 @@ const ghPages = async (pkg) => {
     : [opts.branch, opts.from, opts.to, opts.msg]
   const msg = restJoin(_msg, pkg, 'docs: update docs ${{name}} ${{version}}')
 
-  console.log(`[${pkg.name}] publish docs to ${branch}`)
+  log({pkg})(`publish docs to ${branch}`)
 
   await push({
     cwd: path.join(pkg.absPath, from),

package/src/main/js/repo.js

@@ -1,5 +1,6 @@
 import {$, ctx, fs, path, tempy, copy} from 'zx-extra'
 import {parseEnv} from './config.js'
+import {log} from './util.js'
 
 const branches = {}
 export const fetch = async ({cwd: _cwd, branch, origin: _origin}) => ctx(async ($) => {
@@ -14,7 +15,7 @@ export const fetch = async ({cwd: _cwd, branch, origin: _origin}) => ctx(async (
   try {
     await $`git clone --single-branch --branch ${branch} --depth 1 ${origin} .`
   } catch (e) {
-    console.warn(`ref '${branch}' does not exist in ${origin}`)
+    log({level: 'warn'})(`ref '${branch}' does not exist in ${origin}`)
     await $`git init .`
     await $`git remote add origin ${origin}`
   }
@@ -41,7 +42,7 @@ export const push = async ({cwd, from, to, branch, origin, msg, ignoreFiles, fil
   try {
     await $`git commit -m ${msg}`
   } catch {
-    console.warn(`no changes to commit to ${branch}`)
+    log({level: 'warn'})(`no changes to commit to ${branch}`)
     return
   }
 

package/src/main/js/tag.js

@@ -3,6 +3,7 @@
 import {ctx, semver, $} from 'zx-extra'
 import {Buffer} from 'buffer'
 import {parseEnv} from './config.js'
+import {log} from './util.js'
 
 export const pushTag = (pkg) => ctx(async ($) => {
   const {absPath: cwd, name, version} = pkg
@@ -10,7 +11,7 @@ export const pushTag = (pkg) => ctx(async ($) => {
   const {gitCommitterEmail, gitCommitterName} = parseEnv($.env)
 
   pkg.context.git.tag = tag
-  console.log(`[${name}] push release tag ${tag}`)
+  log({pkg})(`push release tag ${tag}`)
 
   $.cwd = cwd
   await $`git config user.name ${gitCommitterName}`

package/src/main/js/util.js

@@ -1,4 +1,4 @@
-import {$} from 'zx-extra'
+import {$, fs} from 'zx-extra'
 
 export const tpl = (str, context) =>
   str?.replace(/\$\{\{\s*([.a-z0-9]+)\s*}}/gi, (matched, key) => get(context, key) ?? '')
@@ -14,13 +14,88 @@ export const get = (obj, path = '.') => {
     return result
 }
 
+export const set = (obj, path, value) => {
+    const chunks = path.split('.').filter(Boolean)
+    let result = obj
+
+    for (let i = 0, len = chunks.length; i < len && result !== undefined && result !== null; i++) {
+        if (i === len - 1) {
+            result[chunks[i]] = value
+        } else {
+            result[chunks[i]] = result[chunks[i]] || {}
+            result = result[chunks[i]]
+        }
+    }
+
+    return result
+}
+
 export const runHook = async (pkg, name) => {
     const cmd = tpl(pkg.config[name], {...pkg, ...pkg.context})
 
     if (cmd) {
-        console.log(`[${pkg.name}] run ${name} '${cmd}'`)
+        log({pkg})(`run ${name} '${cmd}'`)
         await $.o({cwd: pkg.absPath, quote: v => v})`${cmd}`
     }
 }
 
 export const restJoin = (rest, context, def) => tpl(rest.filter(Boolean).join(' ') || def, context)
+
+export const createReporter = (file, logger = console) => {
+    const state = {
+        status: 'initial',
+        queue: [],
+        packages: [],
+        events: [],
+    }
+
+    return {
+        setQueue(queue, packages) {
+            state.queue = queue
+            state.packages = queue.map(name => {
+                const {manifest: {version}, absPath} = packages[name]
+                return {
+                    status: 'initial',
+                    name,
+                    version,
+                    path: absPath
+                }
+            })
+        },
+        getState(key, pkgName) {
+            const _state = pkgName ? state.packages.find(({name}) => name === pkgName) : state
+            return get(_state, key)
+        },
+        setState(key, value, pkgName) {
+            const _state = pkgName ? state.packages.find(({name}) => name === pkgName) : state
+            set(_state, key, value)
+        },
+        setStatus(status, name) {
+            this.setState('status', status, name)
+
+            this.persistState()
+        },
+        getStatus (status, name) {
+            return this.getState('status', name)
+        },
+        log(ctx = {}) { return (...chunks) => {
+            const {pkg, scope = pkg?.name || '~', level = 'info'} = ctx
+            const msg = chunks.map(c => typeof c === 'string' ? tpl(c, ctx) : c)
+            const event = {msg, scope, date: Date.now(), level}
+            state.events.push(event)
+            logger[level](`[${scope}]`, ...msg)
+        }},
+        persistState() {
+            file && fs.writeJsonSync(file, JSON.stringify(state))
+        }
+    }
+}
+
+export const log = (ctx) => {
+    if (!$.r) {
+        $.r = createReporter()
+    }
+
+    return $.r.log(ctx)
+}
+

package/src/test/js/integration.test.js

@@ -7,6 +7,7 @@ import {formatTag} from '../../main/js/tag.js'
 import {addCommits, createFakeRepo, createNpmRegistry, fixtures} from './test-utils.js'
 
 const test = suite('integration')
+const report = tempy.temporaryFile()
 
 const cwd = await createFakeRepo({
   commits: [
@@ -162,7 +163,25 @@ $.cwd = cwd
 await $`yarn install`
 
 test('run() dry-run', async () => {
-  await run({cwd, flags: {dryRun: true}})
+  await run({cwd, flags: {dryRun: true, report}})
+
+  const r = JSON.parse(await fs.readJson(report))
+  const [a, b] = r.packages
+
+  assert.equal(r.queue, ['a', 'b'])
+  assert.equal(r.status, 'success')
+
+  assert.equal(a.name, 'a')
+  assert.equal(a.version, '1.0.1')
+  assert.equal(a.prevVersion, 'v1.0.0')
+  assert.equal(a.releaseType, 'patch')
+  assert.equal(a.status, 'success')
+
+  assert.equal(b.name, 'b')
+  assert.equal(b.version, '1.0.0')
+  assert.equal(b.prevVersion, '1.0.0')
+  assert.equal(b.releaseType, 'minor')
+  assert.equal(b.status, 'success')
 })
 
 test('run()', async () => {

package/src/test/js/util.test.js

@@ -1,6 +1,6 @@
 import {suite} from 'uvu'
 import * as assert from 'uvu/assert'
-import {tpl} from '../../main/js/util.js'
+import {tpl, get, set} from '../../main/js/util.js'
 
 const test = suite('util')
 
@@ -30,5 +30,16 @@ test('tpl()', () => {
   })
 })
 
+test('set/get()', () => {
+  const obj = {arr: [{}]}
+
+  set(obj, 'foo.bar', 'baz')
+  set(obj, 'arr.0.name', 'name')
+  assert.equal(get(obj, 'foo.bar'), 'baz')
+  assert.equal(get(obj, 'arr.0.name'), 'name')
+  assert.equal(get(obj, '.'), obj)
+  assert.equal(get(obj), obj)
+})
+
 test.run()