zx-bulk-release 1.7.8 → 1.9.1

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [1.9.1](https://github.com/semrel-extra/zx-bulk-release/compare/v1.9.0...v1.9.1) (2022-06-26)
+
+### Fixes & improvements
+* refactor: replace postbuild hook with postupdate ([b7d68a5](https://github.com/semrel-extra/zx-bulk-release/commit/b7d68a5a2b9dec6516204f3fcbbc3c08db9c6d90))
+
+## [1.9.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.8.0...v1.9.0) (2022-06-26)
+
+### Features
+* feat: add gh-pages push ([32130b6](https://github.com/semrel-extra/zx-bulk-release/commit/32130b64a2088cc98b1cae678691cd55c18fe0a3))
+
+## [1.8.0](https://github.com/semrel-extra/zx-bulk-release/compare/v1.7.8...v1.8.0) (2022-06-26)
+
+### Features
+* feat: add cosmiconfig ([1fe694d](https://github.com/semrel-extra/zx-bulk-release/commit/1fe694d2c919a029eb4aa5d5f500b287a2035608))
+
+### Fixes & improvements
+* docs: formatting ([d2bac88](https://github.com/semrel-extra/zx-bulk-release/commit/d2bac8893d33f4c9ce6c003c4f7188ea56452023))
+
 ## [1.7.8](https://github.com/semrel-extra/zx-bulk-release/compare/v1.7.7...v1.7.8) (2022-06-26)
 
 ### Fixes & improvements

package/README.md

@@ -3,25 +3,51 @@
 
 🚧 Work in progress. Early access preview
 
+## 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.
+
 ## Requirements
 * macOS / linux
 * Node.js >= 16.0.0
-* yarn >= 4.0.0-rc.5
+* npm >=7 / yarn >= 3
 
 ## Usage
+### CLI
 ```shell
 GH_TOKEN=ghtoken GH_USER=username NPM_TOKEN=npmtoken npx zx-bulk-release [opts]
 ```
 
-## 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.
+### JS API
+```js
+import { run } from 'zx-bulk-release'
+
+const cwd = '/foo/bar'
+const env = {GH_TOKEN: 'foo', NPM_TOKEN: 'bar'}
+const flags = {dryRun: true}
 
-## Tags
-[Lerna](https://github.com/lerna/lerna) tags (like `@pkg/name@v1.0.0-beta.0`) are suitable for monorepos, but they don’t follow [semver spec](https://semver.org/). Therefore, we propose another contract: 
+await run({
+  cwd,    // Defaults to process.cwd()
+  flags,  // Defaults to process.env
+  env     // Defaults to minimist-parsed `process.argv.slice(2)`
+})
+```
+
+### Config
+Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format: `.releaserc`, `.release.json`, `.release.yaml`, etc.
+```yaml
+buildCmd:      'yarn build'
+postbuildCmd:  'yarn install'
+testCmd:       'yarn test'
+fetch:         true
+```
+
+## Implementation notes
+### Tags
+[Lerna](https://github.com/lerna/lerna) tags (like `@pkg/name@v1.0.0-beta.0`) are suitable for monorepos, but they don’t follow [semver spec](https://semver.org/). Therefore, we propose another contract:
 ```js
 '2022.6.13-optional-org.pkg-name.v1.0.0-beta.1+sha.1-f0'
 // date    name                  version             format
@@ -32,18 +58,7 @@ Note, [npm-package-name charset](https://www.npmjs.com/package/validate-npm-pack
 // date    name       ver    b64             format
 ```
 
-## JS API
-```js
-import { run } from 'zx-bulk-release'
-
-const cwd = '/foo/bar' // Defaults to process.cwd()
-const env = { GH_TOKEN: 'foo', NPM_TOKEN: 'bar' } // Defaults to process.env
-const flags = {dryRun: true}
-
-await run({cwd, flags, env})
-```
-
-## env vars
+### env vars
 ```js
 export const parseEnv = (env = process.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
@@ -61,6 +76,23 @@ export const parseEnv = (env = process.env) => {
 }
 ```
 
+### Meta
+
+Each release projects its result into the `meta` branch.  
+`2022-6-26-semrel-extra-zxbr-test-c-1-3-1-f0.json`
+```json
+{
+  "META_VERSION": "1",
+  "name": "@semrel-extra/zxbr-test-c",
+  "hash": "07b7df33f0159f674c940bd7bbb2652cdaef5207",
+  "version": "1.3.1",
+  "dependencies": {
+    "@semrel-extra/zxbr-test-a": "^1.4.0",
+    "@semrel-extra/zxbr-test-d": "~1.2.0"
+  }
+}
+```
+
 ## References
 * [semrel-extra/zx-semrel](https://github.com/semrel-extra/zx-semrel)
 * [dhoulb/multi-semantic-release](https://github.com/dhoulb/multi-semantic-release)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zx-bulk-release",
-  "version": "1.7.8",
+  "version": "1.9.1",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": "./src/main/js/index.js",
@@ -12,9 +12,10 @@
   },
   "dependencies": {
     "@semrel-extra/topo": "^1.4.1",
+    "cosmiconfig": "^7.0.1",
     "git-glob-cp": "^1.7.1",
     "ini": "^3.0.0",
-    "zx-extra": "^1.7.0"
+    "zx-extra": "^1.7.1"
   },
   "devDependencies": {
     "c8": "^7.11.3",

package/src/main/js/build.js

@@ -9,21 +9,23 @@ export const build = (pkg, packages) => ctx(async ($) => {
 
   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)
+  const {config} = pkg
+  $.cwd = pkg.absPath
 
-    if (!pkg.fetched) {
-      $.cwd = pkg.absPath
+  if (config.buildCmd) {
+    if (pkg.changes?.length === 0 && config.fetch) await fetchPkg(pkg)
 
-      await $`yarn build`
+    if (!pkg.fetched) {
+      await $.raw`${config.buildCmd}`
       console.log(`built '${pkg.name}'`)
+    }
+
+    // if (config.postbuildCmd) await $.raw`${config.postbuildCmd}`
 
-      if (pkg.manifest.scripts?.test && pkg.manifest?.release?.test) {
-        await $`yarn test`
-        console.log(`tested '${pkg.name}'`)
-      }
+    if (!pkg.fetched && config.testCmd) {
+      await $.raw`${config.testCmd}`
+      console.log(`tested '${pkg.name}'`)
     }
-    await $`yarn install`
   }
 
   pkg.built = true

package/src/main/js/config.js

@@ -0,0 +1,27 @@
+import { cosmiconfig } from 'cosmiconfig'
+
+const CONFIG_NAME = 'release'
+const CONFIG_FILES = [
+  'package.json',
+  `.${CONFIG_NAME}rc`,
+  `.${CONFIG_NAME}rc.json`,
+  `.${CONFIG_NAME}rc.yaml`,
+  `.${CONFIG_NAME}rc.yml`,
+  `.${CONFIG_NAME}rc.js`,
+  `.${CONFIG_NAME}rc.cjs`,
+  `${CONFIG_NAME}.config.js`,
+  `${CONFIG_NAME}.config.cjs`
+]
+
+export const defaultConfig = {
+  buildCmd: 'yarn build',
+  postbuildCmd: 'yarn install',
+  testCmd: 'yarn test',
+  fetch: true
+}
+
+export const getConfig = async (...cwds) =>
+  (await Promise.all(cwds.map(
+    cwd => cosmiconfig(CONFIG_NAME, { searchPlaces: CONFIG_FILES }).search(cwd).then(r => r?.config)
+  ))).find(Boolean) || defaultConfig
+

package/src/main/js/index.js

@@ -1,9 +1,10 @@
-import {fs, ctx} from 'zx-extra'
+import {fs, $} from 'zx-extra'
 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'
+import {getConfig} from './config.js'
 
 export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} = {}) => {
   const {packages, queue, root} = await topo({cwd})
@@ -11,6 +12,7 @@ export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} =
 
   for (let name of queue) {
     const pkg = packages[name]
+    pkg.config = await getConfig(pkg.absPath, root.absPath)
     pkg.latest = await getLatest(cwd, name)
 
     const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
@@ -24,6 +26,7 @@ export const run = async ({cwd = process.cwd(), env = process.env, flags = {}} =
     if (changes.length === 0) continue
     console.log(`semantic changes of '${name}'`, changes)
 
+    $.o({cwd: pkg.absPath})`yarn install`
     pkg.build = await build(pkg, packages, cwd)
 
     if (dryRun) continue

package/src/main/js/publish.js

@@ -7,6 +7,7 @@ export const publish = async (pkg) => {
   await pushMeta(pkg)
   await npmPublish(pkg)
   await createGhRelease(pkg)
+  await ghPages(pkg)
 }
 
 export const pushTag = (pkg) => ctx(async ($) => {
@@ -98,6 +99,22 @@ ${commits.join('\n')}`).join('\n')
   await $`curl -u ${ghUser}:${ghToken} -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/${repoName}/releases -d ${releaseData}`
 })
 
+const ghPages = async (pkg) => {
+  const {config} = pkg
+  if (!config.ghPages) return
+
+  console.log('publish to gh-pages')
+  const [from, branch = 'gh-pages', to = '.'] = config.ghPages.split(' ')
+
+  await push({
+    cwd: path.resolve(pkg.absPath, from),
+    from: '.',
+    to,
+    branch,
+    msg: 'docs update'
+  })
+}
+
 const branches = {}
 export const fetch = async ({cwd: _cwd, branch, origin: _origin}) => ctx(async ($) => {
   let cwd = branches[branch]
@@ -127,14 +144,20 @@ export const push = async ({cwd, from, to, branch, origin, msg, ignoreFiles, fil
     const _contents = typeof contents === 'string' ? contents : JSON.stringify(contents, null, 2)
     await fs.outputFile(path.resolve(_cwd, to, relpath), _contents)
   }
-  if (from) await copydir({baseFrom: cwd, from, baseTo: _cwd, to, ignoreFiles})
+  if (from) await copydir({baseFrom: cwd, from, baseTo: _cwd, to, ignoreFiles, cwd})
 
   $.cwd = _cwd
 
   await $`git config user.name ${gitCommitterEmail}`
   await $`git config user.email ${gitCommitterName}`
   await $`git add .`
-  await $`git commit -m ${msg}`
+  try {
+    await $`git commit -m ${msg}`
+  } catch {
+    console.warn('no changes')
+    return
+  }
+
   await $.raw`git push origin HEAD:refs/heads/${branch}`
 })
 

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

@@ -49,9 +49,10 @@ const cwd = await createFakeRepo({
               test: "node ./index.js"
             },
             release: {
-              build: true,
-              fetch: true,
-              test: true
+              buildCmd: 'yarn build',
+              postbuildCmd: 'yarn install',
+              testCmd: 'yarn test',
+              fetch: true
             },
             exports: {
               '.': {
@@ -107,13 +108,15 @@ const cwd = await createFakeRepo({
               a: 'workspace:^'
             },
             scripts: {
-              build: 'cp index.js bundle.js',
+              build: 'cp index.js bundle.js && mkdir -p docs && echo "# docs" > docs/readme.md',
               test: "node ./index.js"
             },
             release: {
-              build: true,
+              buildCmd: 'yarn build',
+              postbuildCmd: 'yarn install',
+              testCmd: 'yarn test',
               fetch: true,
-              test: true
+              ghPages: 'docs gh-pages b'
             },
             exports: {
               '.': {
@@ -207,9 +210,13 @@ test('run()', async () => {
 
     const origin = (await $`git remote get-url origin`).toString().trim()
     const meta = tempy.temporaryDirectory()
+    const ghp = 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 $`git clone --single-branch --branch gh-pages --depth 1 ${origin} ${ghp}`
+    assert.is((await fs.readFile(`${ghp}/b/readme.md`, 'utf-8')).trim(), '# docs')
   })
 
   await registry.stop()