zx-bulk-release 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [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
+* fix: fix commits refs in release data ([1ddd2e9](https://github.com/semrel-extra/zx-bulk-release/commit/1ddd2e99e88e245bf5d6b477adb6fca0d2c4c663))
+
 ## [1.4.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.3.0...v1.4.0) (2022-06-21)
 
 ### Features

package/package.json

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

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, change, short, hash}) => {
-      const {commits} = acc[group] || (acc[group] = {commits: [], group})
-      const commitRef = `* ${change} ([${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

@@ -121,7 +121,7 @@ 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 registry.stop()