zx-bulk-release 1.4.1 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [1.6.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.5.0...v1.6.0) (2022-06-25)
+
+### Features
+* feat: add lazy builder ([4c59a0e](https://github.com/semrel-extra/zx-bulk-release/commit/4c59a0e61aea19cccd66228f34100d733bc3d3d8))
+* feat: provide pkg building ([04ac6ce](https://github.com/semrel-extra/zx-bulk-release/commit/04ac6cee878aa8cfa329b16348735ba809544bea))
+
+### Fixes & improvements
+* refactor: reuse `traverseDeps` ([626de1c](https://github.com/semrel-extra/zx-bulk-release/commit/626de1c9250bce831aa9ec6298077bd5b91e06b0))
+
+## [1.5.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.4.2...v1.5.0) (2022-06-21)
+
+### Features
+* feat: add commit-ish to meta ([9092a4d](https://github.com/semrel-extra/zx-bulk-release/commit/9092a4d41f51fb58a9d7cb1696bb9ee3f07c9133))
+
+## [1.4.2](https://github.com/semrel-extra/zx-bulk-release/compare/v1.4.1...v1.4.2) (2022-06-21)
+
+### Fixes & improvements
+* refactor: use common iface for push internals ([e614e42](https://github.com/semrel-extra/zx-bulk-release/commit/e614e42d8b323749082b94611f4552fdacebe1f5))
+
 ## [1.4.1](https://github.com/semrel-extra/zx-bulk-release/compare/v1.4.0...v1.4.1) (2022-06-21)
 
 ### Fixes & improvements

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "zx-bulk-release",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": "./src/main/js/index.js",
   "bin": "./src/main/js/cli.js",
   "scripts": {
     "test": "NPM_REGISTRY='http://localhost:4873' NPM_TOKEN='mRv6eIuiaggXGb9ZDFCtBA==' c8 uvu ./src/test -i fixtures -i utils && c8 report -r lcov",
+    "test:it": "NPM_REGISTRY='http://localhost:4873' NPM_TOKEN='mRv6eIuiaggXGb9ZDFCtBA==' node ./src/test/js/integration.test.js",
     "docs": "mkdir -p docs && cp ./README.md ./docs/README.md"
   },
   "dependencies": {
     "@semrel-extra/topo": "^1.4.1",
-    "git-glob-cp": "^1.5.1",
+    "git-glob-cp": "^1.7.1",
+    "ini": "^3.0.0",
     "zx-extra": "^1.7.0"
   },
   "devDependencies": {
     "c8": "^7.11.3",
-    "uvu": "^0.5.3",
-    "verdaccio": "^5.13.0"
+    "uvu": "^0.5.4",
+    "verdaccio": "^5.13.1"
   },
   "publishConfig": {
     "access": "public"

package/src/main/js/build.js

@@ -0,0 +1,52 @@
+import {ctx, 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 ($) => {
+  if (pkg.built) return true
+
+  await traverseDeps(pkg, packages, async (_, {pkg}) => build(pkg, packages))
+
+  if (pkg.manifest.scripts?.build && pkg.manifest?.release?.build) {
+    if (pkg.changes?.length === 0 && pkg.manifest?.release?.fetch) await fetchPkg(pkg)
+
+    if (!pkg.fetched) {
+      $.cwd = pkg.absPath
+      await $`npm run build`
+      console.log(`built '${pkg.name}'`)
+    }
+  }
+
+  pkg.built = true
+
+  return true
+})
+
+const fetchPkg = (pkg) => ctx(async ($) => {
+  try {
+    const cwd = pkg.absPath
+    const {npmRegistry} = parseEnv($.env)
+    const temp = tempy.temporaryDirectory()
+    const npmrc = ini.parse(await fs.readFile(`${cwd}/.npmrc`, 'utf8'))
+    const token = getAuthToken(npmRegistry, npmrc)
+    const auth = `Authorization: Bearer ${token}`
+    const tarball = getTarballUrl(npmRegistry, pkg.name, pkg.version)
+
+    await $`wget --header=${auth} -qO- ${tarball} | tar xvz -C ${temp}`
+    await copy({from: ['**/*', '!package.json'], to: cwd, cwd: `${temp}/package`})
+
+    pkg.fetched = true
+    console.log(`fetched '${pkg.name}@${pkg.version}'`)
+  } catch (e) {
+    console.log(`fetching '${pkg.name}@${pkg.version}' failed`, e)
+  }
+})
+
+// NOTE registry-auth-token does not work with localhost:4873
+const getAuthToken = (registry, npmrc) =>
+  (Object.entries(npmrc).find(([reg]) => reg.startsWith(registry.replace(/^https?/, ''))) || [])[1]
+
+// $`npm view ${name}@${version} dist.tarball`
+const getTarballUrl = (registry, name, version) => `${registry}/${name}/-/${name.replace(/^.+(%2f|\/)/,'')}-${version}.tgz`

package/src/main/js/deps.js

@@ -2,9 +2,8 @@ import {semver} from 'zx-extra'
 
 export const depScopes = ['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies']
 
-export const updateDeps = async (pkg, packages) => {
+export const traverseDeps = async (pkg, packages, fn) => {
   const {manifest} = pkg
-  const changes = []
 
   for (let scope of depScopes) {
     const deps = manifest[scope]
@@ -13,24 +12,32 @@ export const updateDeps = async (pkg, packages) => {
     for (let [name, version] of Object.entries(deps)) {
       if (!packages[name]) continue
 
-      const prev = pkg.latest.meta?.[scope]?.[name]
-      const actual = packages[name]?.version
-      const next = resolveVersion(version, actual, prev)
+      await fn(pkg, {name, version, deps, scope, pkg: packages[name]})
+    }
+  }
+}
 
-      pkg[scope] = {...pkg[scope], [name]: next || version}
+export const updateDeps = async (pkg, packages) => {
+  const changes = []
 
-      if (!next) continue
+  await traverseDeps(pkg, packages, async (_, {name, version, deps, scope, pkg: dep}) => {
+    const prev = pkg.latest.meta?.[scope]?.[name]
+    const actual = dep?.version
+    const next = resolveVersion(version, actual, prev)
 
-      deps[name] = next
+    pkg[scope] = {...pkg[scope], [name]: next || version}
 
-      changes.push({
-        group: 'Dependencies',
-        releaseType: 'patch',
-        change: 'perf',
-        subj: `perf: ${name} updated to ${next}`,
-      })
-    }
-  }
+    if (!next) return
+
+    deps[name] = next
+
+    changes.push({
+      group: 'Dependencies',
+      releaseType: 'patch',
+      change: 'perf',
+      subj: `perf: ${name} updated to ${next}`,
+    })
+  })
 
   return changes
 }

package/src/main/js/index.js

@@ -3,8 +3,10 @@ import {topo} from '@semrel-extra/topo'
 import {updateDeps} from './deps.js'
 import {getSemanticChanges, resolvePkgVersion} from './analyze.js'
 import {publish, getLatest} from './publish.js'
+import {build} from './build.js'
 
 export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} = {}) => {
+  console.log('Run zx bulk release')
   const {packages, queue} = await topo({cwd})
   const dryRun = flags['dry-run'] || flags.dryRun
 
@@ -23,6 +25,7 @@ export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} =
     if (changes.length === 0) continue
     console.log(`semantic changes of '${name}'`, changes)
 
+    pkg.build = await build(pkg, packages)
     if (dryRun) continue
 
     await fs.writeJson(pkg.manifestPath, pkg.manifest, {spaces: 2})

package/src/main/js/publish.js

@@ -2,8 +2,101 @@ import {formatTag, getLatestTag} from './tag.js'
 import {tempy, ctx, fs, path} from 'zx-extra'
 import {copydir} from 'git-glob-cp'
 
-const branches = {}
-const META_VERSION = '1'
+export const publish = async (pkg) => {
+  await pushTag(pkg)
+  await pushMeta(pkg)
+  await npmPublish(pkg)
+  await createGhRelease(pkg)
+}
+
+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}`)
+
+  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`')
+
+  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 meta = {
+    META_VERSION: '1',
+    name: pkg.name,
+    hash,
+    version: pkg.version,
+    dependencies: pkg.dependencies,
+    devDependencies: pkg.devDependencies,
+    peerDependencies: pkg.peerDependencies,
+    optionalDependencies: pkg.optionalDependencies,
+  }
+  const files = [{relpath: `${getArtifactPath(tag)}.json`, contents: meta}]
+
+  await push({cwd, to, branch, msg, files})
+})
+
+export const npmPublish = ({absPath: cwd}) => ctx(async ($) => {
+  const {npmRegistry, npmToken, npmConfig} = parseEnv($.env)
+  const npmrc = npmConfig ? npmConfig : path.resolve(cwd, '.npmrc')
+
+  console.log(`publish npm package to ${npmRegistry}`)
+  $.cwd = cwd
+  if (!npmConfig) {
+    await $.raw`echo ${npmRegistry.replace(/https?:/, '')}/:_authToken=${npmToken} >> ${npmrc}`
+  }
+  await $`npm publish --no-git-tag-version --registry=${npmRegistry} --userconfig ${npmrc} --no-workspaces`
+})
+
+export const createGhRelease = (pkg) => ctx(async ($) => {
+  console.log('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 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
+    .reduce((acc, {group, subj, short, hash}) => {
+      const {commits} = acc[group] || (acc[group] = {commits: [], group})
+      const commitRef = `* ${subj}${short ? ` [${short}](${repoPublicUrl}/commit/${hash})` : ''}`
+
+      commits.push(commitRef)
+
+      return acc
+    }, {}))
+    .map(({group, commits}) => `
+### ${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}`
+})
 
 export const getOrigin = (cwd) => ctx(async ($) => {
   $.cwd = cwd
@@ -16,6 +109,7 @@ export const getOrigin = (cwd) => ctx(async ($) => {
     : originUrl
 })
 
+const branches = {}
 export const fetch = async ({cwd: _cwd, branch, origin: _origin}) => ctx(async ($) => {
   let cwd = branches[branch]
   if (cwd) return cwd
@@ -55,33 +149,6 @@ export const push = async ({cwd, from, to, branch, origin, msg, ignoreFiles, fil
   await $.raw`git push origin HEAD:refs/heads/${branch}`
 })
 
-export const publish = async (pkg, env) => ctx(async ($) => {
-  const {name, version} = pkg.manifest
-  const tag = formatTag({name, version})
-  const cwd = pkg.absPath
-  const {gitCommitterEmail, gitCommitterName, npmRegistry} = parseEnv(env)
-
-  $.cwd = cwd
-  $.env = env
-
-  console.log(`push release tag ${tag}`)
-  await $`git config user.name ${gitCommitterName}`
-  await $`git config user.email ${gitCommitterEmail}`
-  await $`git tag -m ${tag} ${tag}`
-  await $`git push origin ${tag}`
-
-  console.log('push artifact to branch `meta`')
-  await pushMeta(pkg)
-
-  console.log(`publish npm package to ${npmRegistry}`)
-  const npmrc = path.resolve(cwd, '.npmrc')
-  await $.raw`echo ${npmRegistry.replace(/https?:/, '')}/:_authToken=${$.env.NPM_TOKEN} >> ${npmrc}`
-  await $`npm publish --no-git-tag-version --registry=${npmRegistry} --userconfig ${npmrc} --no-workspaces`
-
-  console.log('create gh release')
-  await createGhRelease(pkg)
-})
-
 export const getArtifactPath = (tag) => tag.toLowerCase().replace(/[^a-z0-9-]/g, '-')
 
 export const getLatestMeta = async (cwd, tag) => {
@@ -89,33 +156,15 @@ export const getLatestMeta = async (cwd, tag) => {
 
   try {
     const _cwd = await fetch({cwd, branch: 'meta'})
-    return await fs.readJson(path.resolve(_cwd, getArtifactPath(tag), 'meta.json'))
+    return await Promise.any([
+      fs.readJson(path.resolve(_cwd, `${getArtifactPath(tag)}.json`)),
+      fs.readJson(path.resolve(_cwd, getArtifactPath(tag), 'meta.json'))
+    ])
   } catch {}
 
   return null
 }
 
-export const pushMeta = async (pkg) => {
-  const cwd = pkg.absPath
-  const {name, version} = pkg
-  const tag = formatTag({name, version})
-  const to = getArtifactPath(tag)
-  const branch =  'meta'
-  const msg =  `chore: release meta ${name} ${version}`
-  const meta = {
-    META_VERSION,
-    name: pkg.name,
-    version: pkg.version,
-    dependencies: pkg.dependencies,
-    devDependencies: pkg.devDependencies,
-    peerDependencies: pkg.peerDependencies,
-    optionalDependencies: pkg.optionalDependencies,
-  }
-  const files = [{relpath: 'meta.json', contents: meta}]
-
-  await push({cwd, to, branch, msg, files})
-}
-
 export const getLatest = async (cwd, name) => {
   const tag = await getLatestTag(cwd, name)
   const meta = await getLatestMeta(cwd, tag?.ref)
@@ -127,11 +176,12 @@ export const getLatest = async (cwd, name) => {
 }
 
 export const parseEnv = (env = process.env) => {
-  const {GH_USER, GH_USERNAME, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = 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 {
     ghUser: GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
     ghToken: GH_TOKEN || GITHUB_TOKEN,
+    npmConfig: NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
     npmToken: NPM_TOKEN,
     npmRegistry: NPM_REGISTRY || 'https://registry.npmjs.org',
     gitCommitterName: GIT_COMMITTER_NAME || 'Semrel Extra Bot',
@@ -151,37 +201,3 @@ export const parseRepo = (cwd, origin) => ctx(async ($) => {
     repoPublicUrl
   }
 })
-
-export const createGhRelease = (pkg) => ctx(async ($) => {
-  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 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
-    .reduce((acc, {group, subj, short, hash}) => {
-      const {commits} = acc[group] || (acc[group] = {commits: [], group})
-      const commitRef = `* ${subj}${short ? ` [${short}](${repoPublicUrl}/commit/${hash})` : ''}`
-
-      commits.push(commitRef)
-
-      return acc
-    }, {}))
-    .map(({group, commits}) => `
-### ${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}`
-})

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

@@ -4,7 +4,7 @@ import * as assert from 'uvu/assert'
 import {ctx, tempy, fs} from 'zx-extra'
 import {run} from '../../main/js/index.js'
 import {formatTag} from '../../main/js/tag.js'
-import {createFakeRepo, createNpmRegistry} from './test-utils.js'
+import {addCommits, createFakeRepo, createNpmRegistry} from './test-utils.js'
 
 const test = suite('integration')
 
@@ -32,7 +32,14 @@ const cwd = await createFakeRepo({
         {
           relpath: './packages/a/package.json',
           contents: {
-            name: 'a'
+            name: 'a',
+            scripts: {
+              build: 'echo "building a"'
+            },
+            release: {
+              build: true,
+              fetch: true
+            }
           }
         }
       ]
@@ -74,6 +81,10 @@ const cwd = await createFakeRepo({
             name: 'b',
             dependencies: {
               a: '1.0.0'
+            },
+            release: {
+              build: true,
+              fetch: true
             }
           }
         }
@@ -110,7 +121,6 @@ test('run()', async () => {
 
     assert.is(digestA['dist-tags'].latest, '1.0.1')
     assert.is(digestA.dist.tarball, 'http://localhost:4873/a/-/a-1.0.1.tgz')
-
     assert.is(digestB['dist-tags'].latest, '1.0.0')
     assert.is(digestB.dist.tarball, 'http://localhost:4873/b/-/b-1.0.0.tgz')
 
@@ -121,7 +131,41 @@ test('run()', async () => {
     const meta = 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, '-')}/meta.json`)).version, '1.0.1')
+    assert.is((await fs.readJson(`${meta}/${tag.toLowerCase().replace(/[^a-z0-9-]/g, '-')}.json`)).version, '1.0.1')
+  })
+
+  await addCommits({cwd, commits: [
+    {
+      msg: 'feat(b): add feat',
+      files: [
+        {
+          relpath: './packages/b/feat.txt',
+          contents: 'new feat'
+        }
+      ]
+    }
+  ]})
+
+  await run({cwd})
+
+  await ctx(async ($) => {
+    $.cwd = cwd
+    const digestA = JSON.parse((await $`npm view a --registry=${registry.address} --json`).toString())
+    const digestB = JSON.parse((await $`npm view b --registry=${registry.address} --json`).toString())
+
+    assert.is(digestA['dist-tags'].latest, '1.0.1')
+    assert.is(digestA.dist.tarball, 'http://localhost:4873/a/-/a-1.0.1.tgz')
+    assert.is(digestB['dist-tags'].latest, '1.1.0')
+    assert.is(digestB.dist.tarball, 'http://localhost:4873/b/-/b-1.1.0.tgz')
+
+    const tag = formatTag({name: 'b', version: '1.1.0'})
+    assert.is((await $`git for-each-ref refs/tags/${tag} --format='%(contents)'`).toString().trim(), tag)
+
+    const origin = (await $`git remote get-url origin`).toString().trim()
+    const meta = 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.1.0')
   })
 
   await registry.stop()

package/src/test/js/test-utils.js

@@ -30,20 +30,7 @@ export const createFakeRepo = async ({cwd = tempy.temporaryDirectory(), commits
     $.cwd = cwd
     await $`git init`
 
-    for (let {msg, files, name = 'Semrel-extra Bot', email = 'semrel-extra-bot@hotmail.com', tags = []} of commits) {
-      await $`git config user.name ${name}`
-      await $`git config user.email ${email}`
-      for (let {relpath, contents} of files) {
-        const _contents = typeof contents === 'string' ? contents : JSON.stringify(contents, null, 2)
-        await fs.outputFile(path.resolve(cwd, relpath), _contents)
-      }
-      await $`git add .`
-      await $`git commit -m ${msg}`
-
-      for (let tag of tags) {
-        await $`git tag ${tag} -m ${tag}`
-      }
-    }
+    await addCommits({cwd, commits})
 
     const bare = tempy.temporaryDirectory()
     await $`git init --bare ${bare}`
@@ -51,3 +38,25 @@ export const createFakeRepo = async ({cwd = tempy.temporaryDirectory(), commits
 
     return cwd
   })
+
+export const addCommits = async ({cwd, commits = []}) => ctx(async ($) => {
+  $.cwd = cwd
+
+  for (let {msg, files, name = 'Semrel-extra Bot', email = 'semrel-extra-bot@hotmail.com', tags = []} of commits) {
+    await $`git config user.name ${name}`
+    await $`git config user.email ${email}`
+    for (let {relpath, contents} of files) {
+      const _contents = typeof contents === 'string' ? contents : JSON.stringify(contents, null, 2)
+      const file = path.resolve(cwd, relpath)
+      await fs.outputFile(file, _contents)
+
+      await $`git add ${file}`
+    }
+
+    await $`git commit -m ${msg}`
+
+    for (let tag of tags) {
+      await $`git tag ${tag} -m ${tag}`
+    }
+  }
+})