zx-bulk-release 1.23.0 → 1.24.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.24.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.23.0...v1.24.0) (2022-10-15)
+
+### Features
+* feat: add pkg.tag to report ([c3e6d76](https://github.com/semrel-extra/zx-bulk-release/commit/c3e6d76b9001f6935b17eac8496425ce519230e0))
+
+### Fixes & improvements
+* fix: fix report format ([274401c](https://github.com/semrel-extra/zx-bulk-release/commit/274401c8685469801258574c20ae3c4c94f6956f))
+
 ## [1.23.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.22.3...v1.23.0) (2022-10-14)
 
 ### Features

package/README.md

@@ -240,24 +240,46 @@ Each release stores 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
+Release process state is reported to the console and to a file if `--report` flag is set to `/some/path/release-report.json`, for example.
+```js
 {
-  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,
-    }
-  }]
+  status: 'success',            // 'sucess' | 'failure' | 'pending'
+  error: null,                  // null or Error
+  queue: ['a', 'b', 'c', 'd']   // release queue
+  packages: [{
+    name: 'a',
+    version: '1.1.0',
+    path: '/pkg/abs/path',
+    config: {                   // pkg config
+      changelog: 'changelog',
+      npmFetch: true
+    },                 
+    changes: [{                 // semantic changes
+      group: 'Features',
+      releaseType: 'minor',
+      change: 'feat: add feat',
+      subj: 'feat: add feat',
+      body: '',
+      short: '792512c',
+      hash: '792512cccd69c6345d9d32d3d73e2591ea1776b5'
+    }],                  
+    tag: {
+      version: 'v1.1.0',
+      name: 'a',
+      ref: '2022.6.22-a.v1.1.0-f0'
+    },
+    releaseType: 'minor',       // 'major' | 'minor' | 'patch'
+    prevVersion: '1.0.0'        // previous version or null
+  }, {
+    name: 'b',
+    // ...
+  }],
+  events: [
+    {msg: ['zx-bulk-release'], scope:'~', date: 1665839585488, level: 'info'},
+    {msg: ['queue:',['a','b']], scope:'~', date: 1665839585493, level: 'info'},
+    {msg: ["run buildCmd 'yarn && yarn build && yarn test'"], scope: 'a', date:1665839585719, level:'info'},
+    // ...
+  ]
 }
 ```
 

package/package.json

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

package/src/main/js/analyze.js

@@ -1,5 +1,6 @@
 import {ctx, semver} from 'zx-extra'
 import {updateDeps} from './deps.js'
+import {formatTag} from './tag.js';
 import {log} from './util.js'
 
 export const analyze = async (pkg, packages) => {
@@ -12,6 +13,7 @@ export const analyze = async (pkg, packages) => {
   pkg.releaseType = releaseType
   pkg.version = resolvePkgVersion(releaseType, pkg.latest.tag?.version || pkg.manifest.version)
   pkg.manifest.version = pkg.version
+  pkg.tag = releaseType ? formatTag({name: pkg.name, version: pkg.version}) : null
 
   log({pkg})('semantic changes', changes)
 }

package/src/main/js/index.js

@@ -29,6 +29,7 @@ export const run = async ({cwd = process.cwd(), env, flags = {}} = {}) => within
     reporter.setState('version', pkg.version, name)
     reporter.setState('prevVersion', pkg.latest.tag?.version || pkg.manifest.version, name)
     reporter.setState('releaseType', pkg.releaseType, name)
+    reporter.setState('tag', pkg.tag, name)
 
     if (!pkg.releaseType) {
       reporter.setStatus('skipped', name)
@@ -37,7 +38,6 @@ export const run = async ({cwd = process.cwd(), env, flags = {}} = {}) => within
 
     reporter.setStatus('building', name)
     await build(pkg, packages)
-    reporter.setStatus('')
 
     if (flags.dryRun) {
       reporter.setStatus('success', name)

package/src/main/js/npm.js

@@ -38,7 +38,7 @@ export const fetchManifest = async (pkg, {nothrow, env = $.env} = {}) => {
 
 export const npmPublish = (pkg) => ctx(async ($) => {
   const {absPath: cwd, name, version, manifest} = pkg
-  if (manifest.private) return
+  if (manifest.private || pkg.config?.npmPublish === false) return
   const {npmRegistry, npmToken, npmConfig} = parseEnv($.env)
   const npmrc = npmConfig ? npmConfig : path.resolve(cwd, '.npmrc')
 

package/src/main/js/util.js

@@ -86,7 +86,7 @@ export const createReporter = (file, logger = console) => {
             logger[level](`[${scope}]`, ...msg)
         }},
         persistState() {
-            file && fs.writeJsonSync(file, JSON.stringify(state))
+            file && fs.outputJsonSync(file, state)
         }
     }
 }

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

@@ -7,7 +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 report = tempy.temporaryFile({extension: 'json'})
 
 const cwd = await createFakeRepo({
   commits: [
@@ -164,8 +164,7 @@ await $`yarn install`
 
 test('run() dry-run', async () => {
   await run({cwd, flags: {dryRun: true, report}})
-
-  const r = JSON.parse(await fs.readJson(report))
+  const r = await fs.readJson(report)
   const [a, b] = r.packages
 
   assert.equal(r.queue, ['a', 'b'])