zx-bulk-release 1.11.2 → 1.14.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.14.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.13.0...v1.14.0) (2022-06-27)
+
+### Features
+* feat: add config normalizer ([80afee7](https://github.com/semrel-extra/zx-bulk-release/commit/80afee796e71aef6288943b2c6276b6f172192c5))
+
+## [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
+* feat: enhance default gh-pages commit msg ([81ecd7f](https://github.com/semrel-extra/zx-bulk-release/commit/81ecd7f73478c4e1f62d4287b81931e7a8120d58))
+
 ## [1.11.2](https://github.com/semrel-extra/zx-bulk-release/compare/v1.11.1...v1.11.2) (2022-06-26)
 
 ### Fixes & improvements

package/README.md

@@ -10,9 +10,10 @@
 ## Roadmap
 * [x] [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) trigger semantic releases.
 * [x] Predictable [toposort](https://githib.com/semrel-extra/topo)-driven flow.
-* [x] No blocking (no release commits).
-* [ ] Changelogs, docs, bundles go to: release assets and/or meta branch.
-* [x] No extra builds. The required deps are fetched from the pkg registry.
+* [x] No default branch blocking (no release commits).
+* [x] Pkg changelogs go to `changelog` branch (configurable).
+* [x] Docs are published to `gh-pages` branch (configurable).
+* [x] No extra builds. The required deps are fetched from the pkg registry (`npmFetch` flag).
 
 ## Requirements
 * macOS / linux
@@ -42,10 +43,13 @@ await run({
 
 ### Config
 Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format: `.releaserc`, `.release.json`, `.release.yaml`, etc.
-```yaml
-buildCmd:      'yarn && yarn build'
-testCmd:       'yarn test'
-fetch:         true
+```json
+{
+  "cmd": "yarn && yarn build && yarn test",
+  "npmFetch": true,
+  "changelog": "changelog",
+  "ghPages": "gh-pages"
+}
 ```
 
 ## Implementation notes

package/package.json

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

package/src/main/js/build.js

@@ -1,36 +1,29 @@
-import {ctx, tempy, fs} from 'zx-extra'
+import {tempy, fs, $} from 'zx-extra'
 import {copy} from 'git-glob-cp'
 import ini from 'ini'
 import {traverseDeps} from './deps.js'
 import {parseEnv} from './publish.js'
 
-export const build = (pkg, packages) => ctx(async ($) => {
+export const build = async (pkg, packages) => {
   if (pkg.built) return true
 
   await traverseDeps(pkg, packages, async (_, {pkg}) => build(pkg, packages))
 
   const {config} = pkg
 
-  if (config.buildCmd) {
-    if (pkg.changes.length === 0 && config.fetch) await fetchPkg(pkg)
-
+  if (config.cmd) {
+    if (pkg.changes.length === 0 && config.npmFetch) await fetchPkg(pkg)
     if (!pkg.fetched) {
-      $.cwd = pkg.absPath
-      console.log(`build '${pkg.name}'`)
-      await $.raw`${config.buildCmd}`
-
-      if (config.testCmd) {
-        console.log(`test '${pkg.name}'`)
-        await $.raw`${config.testCmd}`
-      }
+      console.log(`[${pkg.name}] run cmd '${config.cmd}'`)
+      await $.o({cwd: pkg.absPath, quote: v => v})`${config.cmd}`
     }
   }
 
   pkg.built = true
   return true
-})
+}
 
-const fetchPkg = (pkg) => ctx(async ($) => {
+const fetchPkg = async (pkg) => {
   try {
     const cwd = pkg.absPath
     const {npmRegistry, npmToken, npmConfig} = parseEnv($.env)
@@ -45,11 +38,11 @@ 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)
   }
-})
+}
 
 // NOTE registry-auth-token does not work with localhost:4873
 const getAuthToken = (registry, npmrc) =>

package/src/main/js/config.js

@@ -14,13 +14,19 @@ const CONFIG_FILES = [
 ]
 
 export const defaultConfig = {
-  buildCmd: 'yarn && yarn build',
-  testCmd: 'yarn test',
-  fetch: true
+  cmd: 'yarn && yarn build && yarn test',
+  npmFetch: true,
+  changelog: 'changelog',
+  ghPages: 'gh-pages'
 }
 
 export const getConfig = async (...cwds) =>
-  (await Promise.all(cwds.map(
+  normalizeConfig((await Promise.all(cwds.map(
     cwd => cosmiconfig(CONFIG_NAME, { searchPlaces: CONFIG_FILES }).search(cwd).then(r => r?.config)
-  ))).find(Boolean) || defaultConfig
+  ))).find(Boolean) || defaultConfig)
 
+export const normalizeConfig = config => ({
+  ...config,
+  npmFetch: config.npmFetch || config.fetch || config.fetchPkg,
+  cmd:      config.cmd || (config.buildCmd ? `${config.buildCmd}${config.testCmd ? ` && ${config.testCmd}` : ''}` : '')
+})

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)
 }
 
@@ -14,28 +15,26 @@ export const pushTag = (pkg) => ctx(async ($) => {
   const {absPath: cwd, name, version} = pkg
   const tag = formatTag({name, version})
   const {gitCommitterEmail, gitCommitterName} = parseEnv($.env)
-  $.cwd = cwd
 
-  console.log(`push release tag ${tag}`)
+  console.log(`[${name}] push release tag ${tag}`)
 
+  $.cwd = cwd
   await $`git config user.name ${gitCommitterName}`
   await $`git config user.email ${gitCommitterEmail}`
   await $`git tag -m ${tag} ${tag}`
   await $`git push origin ${tag}`
 })
 
-export const pushMeta = (pkg) => ctx(async ($) => {
-  console.log('push artifact to branch `meta`')
+export const pushMeta = async (pkg) => {
+  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}`
-
-  $.cwd = cwd
-  const hash = (await $`git rev-parse HEAD`).toString().trim()
+  const branch = 'meta'
+  const msg = `chore: release meta ${name} ${version}`
+  const hash = (await $.o({cwd})`git rev-parse HEAD`).toString().trim()
   const meta = {
     META_VERSION: '1',
     name: pkg.name,
@@ -49,13 +48,14 @@ export const pushMeta = (pkg) => ctx(async ($) => {
   const files = [{relpath: `${getArtifactPath(tag)}.json`, contents: meta}]
 
   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 +63,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,25 +115,18 @@ 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')
-  const [from, branch = 'gh-pages', to = '.', msg = 'docs updated'] = typeof opts === 'string'
+  const [branch = 'gh-pages', from = 'docs', to = '.', msg = `docs: update docs ${pkg.name} ${pkg.version}`] = typeof opts === 'string'
     ? opts.split(' ')
-    : [opts.from, opts.branch, opts.to, opts.msg]
+    : [opts.branch, opts.from, opts.to, opts.msg]
+
+  console.log(`[${pkg.name}] publish docs to ${branch}`)
 
   await push({
     cwd: path.resolve(pkg.absPath, from),
@@ -203,10 +223,9 @@ export const parseEnv = (env = process.env) => {
   }
 }
 
-export const parseRepo = (cwd) => ctx(async ($) => {
-  $.cwd = cwd
+export const parseRepo = async (cwd) => {
   const {ghToken, ghUser} = parseEnv($.env)
-  const originUrl = (await $`git config --get remote.origin.url`).toString().trim()
+  const originUrl = (await $.o({cwd})`git config --get remote.origin.url`).toString().trim()
   const [,,repoHost, repoName] = originUrl.replace(':', '/').replace(/\.git/, '').match(/.+(@|\/\/)([^/]+)\/(.+)$/) || []
   const repoPublicUrl = `https://${repoHost}/${repoName}`
   const repoAuthedUrl = ghToken && ghUser && repoHost && repoName?
@@ -220,4 +239,4 @@ export const parseRepo = (cwd) => ctx(async ($) => {
     repoAuthedUrl,
     originUrl,
   }
-})
+}

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: 'changelog'
             },
             exports: {
               '.': {
@@ -114,7 +115,7 @@ const cwd = await createFakeRepo({
               buildCmd: 'yarn && yarn build',
               testCmd: 'yarn test',
               fetch: true,
-              ghPages: 'docs gh-pages b'
+              ghPages: 'gh-pages docs b'
             },
             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: [