zx-bulk-release 1.12.0 → 1.13.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.13.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.12.0...v1.13.0) (2022-06-27)
+
+### Features
+* feat: add log labels ([a0e80b6](https://github.com/semrel-extra/zx-bulk-release/commit/a0e80b64215c3f69206713cd6073c0240b0930c9))
+* feat: add changelog generator ([4c0914f](https://github.com/semrel-extra/zx-bulk-release/commit/4c0914f24a91e2297f8c6ff8410949c2a0220fb5))
+
 ## [1.12.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.11.2...v1.12.0) (2022-06-26)
 
 ### Features

package/package.json

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

package/src/main/js/build.js

@@ -16,11 +16,11 @@ export const build = (pkg, packages) => ctx(async ($) => {
 
     if (!pkg.fetched) {
       $.cwd = pkg.absPath
-      console.log(`build '${pkg.name}'`)
+      console.log(`[${pkg.name}] build`)
       await $.raw`${config.buildCmd}`
 
       if (config.testCmd) {
-        console.log(`test '${pkg.name}'`)
+        console.log(`[${pkg.name}] test`)
         await $.raw`${config.testCmd}`
       }
     }
@@ -45,9 +45,9 @@ const fetchPkg = (pkg) => ctx(async ($) => {
     await copy({from: ['**/*', '!package.json'], to: cwd, cwd: `${temp}/package`})
 
     pkg.fetched = true
-    console.log(`fetched '${pkg.name}@${pkg.version}'`)
+    console.log(`[${pkg.name}] fetched '${pkg.name}@${pkg.version}'`)
   } catch (e) {
-    console.log(`fetching '${pkg.name}@${pkg.version}' failed`, e)
+    console.log(`[${pkg.name}] fetching '${pkg.name}@${pkg.version}' failed`, e)
   }
 })
 

package/src/main/js/index.js

@@ -7,6 +7,8 @@ import {build} from './build.js'
 import {getConfig} from './config.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
@@ -25,7 +27,7 @@ export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} =
     pkg.manifest.version = pkg.version
 
     if (changes.length === 0) continue
-    console.log(`semantic changes of '${name}'`, changes)
+    console.log(`[${name}] semantic changes`, changes)
 
     await build(pkg, packages, cwd)
 

package/src/main/js/publish.js

@@ -1,12 +1,13 @@
 import {formatTag, getLatestTag} from './tag.js'
-import {tempy, ctx, fs, path} from 'zx-extra'
+import {tempy, ctx, fs, path, $} from 'zx-extra'
 import {copydir} from 'git-glob-cp'
 
 export const publish = async (pkg) => {
   await pushTag(pkg)
   await pushMeta(pkg)
+  await pushChangelog(pkg)
   await npmPublish(pkg)
-  await createGhRelease(pkg)
+  await ghRelease(pkg)
   await ghPages(pkg)
 }
 
@@ -16,7 +17,7 @@ export const pushTag = (pkg) => ctx(async ($) => {
   const {gitCommitterEmail, gitCommitterName} = parseEnv($.env)
   $.cwd = cwd
 
-  console.log(`push release tag ${tag}`)
+  console.log(`[${name}] push release tag ${tag}`)
 
   await $`git config user.name ${gitCommitterName}`
   await $`git config user.email ${gitCommitterEmail}`
@@ -25,14 +26,14 @@ export const pushTag = (pkg) => ctx(async ($) => {
 })
 
 export const pushMeta = (pkg) => ctx(async ($) => {
-  console.log('push artifact to branch `meta`')
+  console.log(`[${pkg.name}] push artifact to branch 'meta'`)
 
   const cwd = pkg.absPath
   const {name, version} = pkg
   const tag = formatTag({name, version})
   const to = '.'
-  const branch =  'meta'
-  const msg =  `chore: release meta ${name} ${version}`
+  const branch = 'meta'
+  const msg = `chore: release meta ${name} ${version}`
 
   $.cwd = cwd
   const hash = (await $`git rev-parse HEAD`).toString().trim()
@@ -51,11 +52,12 @@ export const pushMeta = (pkg) => ctx(async ($) => {
   await push({cwd, to, branch, msg, files})
 })
 
-export const npmPublish = ({absPath: cwd}) => ctx(async ($) => {
+export const npmPublish = (pkg) => ctx(async ($) => {
+  const {absPath: cwd, name, version} = pkg
   const {npmRegistry, npmToken, npmConfig} = parseEnv($.env)
   const npmrc = npmConfig ? npmConfig : path.resolve(cwd, '.npmrc')
 
-  console.log(`publish npm package to ${npmRegistry}`)
+  console.log(`[${name}] publish npm package ${name} ${version} to ${npmRegistry}`)
   $.cwd = cwd
   if (!npmConfig) {
     await $.raw`echo ${npmRegistry.replace(/https?:/, '')}/:_authToken=${npmToken} >> ${npmrc}`
@@ -63,16 +65,43 @@ export const npmPublish = ({absPath: cwd}) => ctx(async ($) => {
   await $`npm publish --no-git-tag-version --registry=${npmRegistry} --userconfig ${npmrc} --no-workspaces`
 })
 
-export const createGhRelease = (pkg) => ctx(async ($) => {
-  console.log('create gh release')
+export const ghRelease = async (pkg) => {
+  console.log(`[${pkg.name}] create gh release`)
 
-  const cwd = pkg.absPath
-  const {name, version} = pkg
   const {ghUser, ghToken} = parseEnv($.env)
-  const {repoName, repoPublicUrl} = await parseRepo(cwd)
-
   if (!ghToken || !ghUser) return null
 
+  const {name, version, absPath: cwd} = pkg
+  const {repoName} = await parseRepo(cwd)
+  const tag = formatTag({name, version})
+  const releaseNotes = await formatReleaseNotes(pkg)
+  const releaseData = JSON.stringify({
+    name: tag,
+    tag_name: tag,
+    body: releaseNotes
+  })
+
+  await $.o({cwd})`curl -u ${ghUser}:${ghToken} -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/${repoName}/releases -d ${releaseData}`
+}
+
+const pushChangelog = async (pkg) => {
+  const {config: {changelog: opts}} = pkg
+  if (!opts) return
+
+  console.log(`[${pkg.name}] push changelog`)
+  const [branch = 'changelog', file = `${pkg.name.replace(/[^a-z0-9-]/ig, '')}-changelog.md`, msg = `chore: update changelog ${pkg.name}`] = typeof opts === 'string'
+    ? opts.split(' ')
+    : [opts.branch, opts.file, opts.msg]
+  const _cwd = await fetch({cwd: pkg.absPath, branch})
+  const releaseNotes = await formatReleaseNotes(pkg)
+
+  await $.o({cwd: _cwd})`echo ${releaseNotes}"\n$(cat ./${file})" > ./${file}`
+  await push({cwd: _cwd, branch, msg})
+}
+
+const formatReleaseNotes = async (pkg) => {
+  const {name, version, absPath: cwd} = pkg
+  const {repoPublicUrl} = await parseRepo(cwd)
   const tag = formatTag({name, version})
   const releaseDiffRef = `## [${name}@${version}](${repoPublicUrl}/compare/${pkg.latest.tag?.ref}...${tag}) (${new Date().toISOString().slice(0, 10)})`
   const releaseDetails = Object.values(pkg.changes
@@ -88,22 +117,14 @@ export const createGhRelease = (pkg) => ctx(async ($) => {
 ### ${group}
 ${commits.join('\n')}`).join('\n')
 
-  const releaseNotes = releaseDiffRef + '\n' + releaseDetails + '\n'
-  const releaseData = JSON.stringify({
-    name: tag,
-    tag_name: tag,
-    body: releaseNotes
-  })
-
-  $.cwd = cwd
-  await $`curl -u ${ghUser}:${ghToken} -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/${repoName}/releases -d ${releaseData}`
-})
+  return releaseDiffRef + '\n' + releaseDetails + '\n'
+}
 
 const ghPages = async (pkg) => {
   const {config: {ghPages: opts}} = pkg
   if (!opts) return
 
-  console.log('publish to gh-pages')
+  console.log(`[${pkg.name}] publish to gh-pages`)
   const [from, branch = 'gh-pages', to = '.', msg = `docs: update docs ${pkg.name} ${pkg.version}`] = typeof opts === 'string'
     ? opts.split(' ')
     : [opts.from, opts.branch, opts.to, opts.msg]

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

@@ -51,7 +51,8 @@ const cwd = await createFakeRepo({
             release: {
               buildCmd: 'yarn && yarn build',
               testCmd: 'yarn test',
-              fetch: true
+              fetch: true,
+              changelog: {}
             },
             exports: {
               '.': {
@@ -174,9 +175,13 @@ test('run()', async () => {
 
     const origin = (await $`git remote get-url origin`).toString().trim()
     const meta = tempy.temporaryDirectory()
+    const chlog = tempy.temporaryDirectory()
 
     await $`git clone --single-branch --branch meta --depth 1 ${origin} ${meta}`
     assert.is((await fs.readJson(`${meta}/${tag.toLowerCase().replace(/[^a-z0-9-]/g, '-')}.json`)).version, '1.0.1')
+
+    await $`git clone --single-branch --branch changelog --depth 1 ${origin} ${chlog}`
+    assert.ok((await fs.readFile(`${chlog}/a-changelog.md`, 'utf-8')).includes('### Fixes & improvements'))
   })
 
   await addCommits({cwd, commits: [