bulk-release 2.3.3 → 2.4.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [2.4.0](https://github.com/semrel-extra/zx-bulk-release/compare/v2.3.3...v2.4.0) (2023-04-09)
+
+### Features
+* feat: support npm preversions (snapshots) publishing ([3ad7df7](https://github.com/semrel-extra/zx-bulk-release/commit/3ad7df752f6085ca010bcb6e0b4ac31260ce512b))
+
 ## [2.3.3](https://github.com/semrel-extra/zx-bulk-release/compare/v2.3.2...v2.3.3) (2023-04-07)
 
 ### Fixes & improvements

package/README.md

@@ -6,8 +6,6 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/bb94e929b1b6430781b5/test_coverage)](https://codeclimate.com/github/semrel-extra/zx-bulk-release/test_coverage)
 [![npm (tag)](https://img.shields.io/npm/v/zx-bulk-release)](https://www.npmjs.com/package/zx-bulk-release)
 
-🚧 Work in progress. Early access preview
-
 ## Key features
 * [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) trigger semantic releases.
 * Automated cross-pkg version bumping.
@@ -37,17 +35,18 @@ yarn add zx-bulk-release
 ```shell
 GH_TOKEN=ghtoken GH_USER=username NPM_TOKEN=npmtoken npx zx-bulk-release [opts]
 ```
-| Flag                         | Description                                                    | Default          |
-|------------------------------|----------------------------------------------------------------|------------------|
-| `--ignore`                   | Packages to ignore: `a, b`                                     |                  |
-| `--include-private`          | Include `private` packages                                     | `false`          |
-| `--concurrency`              | `build/publish` threads limit                                  | `os.cpus.length` |
-| `--no-build`                 | Skip `buildCmd` invoke                                         |                  |
-| `--no-npm-fetch`             | Disable npm artifacts fetching                                 |                  |                      
-| `--only-workspace-deps`      | Recognize only `workspace:` deps as graph edges                |                  |
-| `--dry-run` / `--no-publish` | Disable any publish logic                                      |                  |
-| `--report`                   | Persist release state to file                                  |                  |
-| `--debug`                    | Enable [zx](https://github.com/google/zx#verbose) verbose mode |                  |
+| Flag                         | Description                                                                            | Default          |
+|------------------------------|----------------------------------------------------------------------------------------|------------------|
+| `--ignore`                   | Packages to ignore: `a, b`                                                             |                  |
+| `--include-private`          | Include `private` packages                                                             | `false`          |
+| `--concurrency`              | `build/publish` threads limit                                                          | `os.cpus.length` |
+| `--no-build`                 | Skip `buildCmd` invoke                                                                 |                  |
+| `--no-npm-fetch`             | Disable npm artifacts fetching                                                         |                  |                      
+| `--only-workspace-deps`      | Recognize only `workspace:` deps as graph edges                                        |                  |
+| `--dry-run` / `--no-publish` | Disable any publish logic                                                              |                  |
+| `--report`                   | Persist release state to file                                                          |                  |
+| `--snapshot`                 | Disable any publishing steps except of npm and push packages to the `snapshot` channel |                  |  
+| `--debug`                    | Enable [zx](https://github.com/google/zx#verbose) verbose mode                         |                  |
 
 ### JS API
 ```js
@@ -308,6 +307,7 @@ Release process state is reported to the console and to a file if `--report` fla
 * [nrwl/nx](https://github.com/nrwl/nx)
 * [moonrepo/moon](https://github.com/moonrepo/moon)
 * [ojkelly/yarn.build](https://github.com/ojkelly/yarn.build)
+* [antfu/bumpp](https://github.com/antfu/bumpp)
 
 ## License 
 [MIT](./LICENSE)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bulk-release",
   "alias": "bulk-release",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": {
@@ -22,7 +22,7 @@
     "docs": "mkdir -p docs && cp ./README.md ./docs/README.md"
   },
   "dependencies": {
-    "@semrel-extra/topo": "^1.9.1",
+    "@semrel-extra/topo": "^1.10.0",
     "cosmiconfig": "^8.1.3",
     "queuefy": "^1.2.1",
     "zx-extra": "^2.5.4"
@@ -30,7 +30,7 @@
   "devDependencies": {
     "c8": "^7.13.0",
     "uvu": "^0.5.6",
-    "verdaccio": "^5.23.1"
+    "verdaccio": "^5.23.2"
   },
   "publishConfig": {
     "access": "public"

package/src/main/js/analyze.js

@@ -6,17 +6,20 @@ import {getCommits} from './git.js'
 
 export const analyze = async (pkg) => {
   const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
-  const depsChanges = await updateDeps(pkg, pkg.context.packages)
+  const depsChanges = await updateDeps(pkg)
   const changes = [...semanticChanges, ...depsChanges]
   const releaseType = getNextReleaseType(changes)
+  const pre = pkg.context.flags.snapshot ? `-snap.${pkg.context.git.sha.slice(0, 7)}` : undefined
 
   pkg.changes = changes
   pkg.releaseType = releaseType
   pkg.version = resolvePkgVersion(
     releaseType,
     pkg.latest.tag?.version || pkg.latest.meta?.version,
-    pkg.manifest.version
+    pkg.manifest.version,
+    pre
   )
+  pkg.preversion = pre && pkg.version
   pkg.manifest.version = pkg.version
   pkg.tag = releaseType ? formatTag({name: pkg.name, version: pkg.version}) : null
 
@@ -62,13 +65,12 @@ export const getNextReleaseType = (changes) => changes.length
   ? releaseSeverityOrder.find(type => changes.find(({releaseType}) => type === releaseType))
   : null
 
-export const getNextVersion = (releaseType, prevVersion, defaultVersion = '1.0.0') => {
-  if (!prevVersion) return defaultVersion
+export const getNextVersion = (releaseType, prevVersion, defaultVersion = '1.0.0', pre = '') =>
+  (prevVersion
+    ? semver.inc(prevVersion, releaseType)
+    : defaultVersion) + pre
 
-  return semver.inc(prevVersion, releaseType)
-}
-
-export const resolvePkgVersion = (releaseType, prevVersion, defaultVersion) =>
+export const resolvePkgVersion = (releaseType, prevVersion, defaultVersion, pre) =>
   releaseType
-    ? getNextVersion(releaseType, prevVersion, defaultVersion)
+    ? getNextVersion(releaseType, prevVersion, defaultVersion, pre)
     : prevVersion || null

package/src/main/js/deps.js

@@ -3,14 +3,15 @@ import {topo as _topo, traverseDeps} from '@semrel-extra/topo'
 
 export {traverseQueue, traverseDeps} from '@semrel-extra/topo'
 
-export const updateDeps = async (pkg, packages) => {
+export const updateDeps = async (pkg) => {
   const changes = []
+  const {context: {packages}} = pkg
 
   await traverseDeps({pkg, packages, cb: async ({name, version, deps, scope, pkg: dep}) => {
     const prev = pkg.latest.meta?.[scope]?.[name]
     const actual = dep?.version
     const next = resolveNextVersion(version, actual, prev)
-    const _version = next || subsWorkspace(version, actual)
+    const _version = dep?.preversion || next || subsWorkspace(version, actual) // NOTE preversion should always be pinned
 
     pkg[scope] = {...pkg[scope], [name]: _version}  // Update pkg context
     deps[name] = _version                           // Update manifest

package/src/main/js/npm.js

@@ -35,18 +35,30 @@ export const fetchManifest = async (pkg, {nothrow} = {}) => {
 }
 
 export const npmPublish = async (pkg) => {
-  const {absPath: cwd, name, version, manifest, config} = pkg
-  if (manifest.private || config?.npmPublish === false) return
+  const {absPath: cwd, name, version, manifest, manifestPath, manifestRaw, config: {npmPublish, npmRegistry, npmToken, npmConfig} } = pkg
 
-  const {npmRegistry, npmToken, npmConfig} = config
-  const npmrc = npmConfig ? npmConfig : tempy.temporaryFile({name: '.npmrc'})
+  if (manifest.private || npmPublish === false) return
 
-  log({pkg})(`publish npm package ${name} ${version} to ${npmRegistry}`)
+  log({pkg})(`publishing npm package ${name} ${version} to ${npmRegistry}`)
 
-  if (!npmConfig) {
-    await fs.writeFile(npmrc, `${npmRegistry.replace(/^https?:\/\//, '//')}/:_authToken=${npmToken}`, {encoding: 'utf8'})
+  await fs.writeJson(manifestPath, manifest, {spaces: 2})
+
+  const npmTag = pkg.preversion ? 'snapshot' : 'latest'
+  const npmrc = await getNpmrc({npmConfig, npmToken, npmRegistry})
+
+  await $.o({cwd})`npm publish --no-git-tag-version --registry=${npmRegistry} --userconfig ${npmrc} --tag ${npmTag} --no-workspaces`
+  await fs.writeFile(manifestPath, manifestRaw, {encoding: 'utf8'})
+}
+
+export const getNpmrc = async ({npmConfig, npmToken, npmRegistry}) => {
+  if (npmConfig) {
+    return npmConfig
   }
-  await $.o({cwd})`npm publish --no-git-tag-version --registry=${npmRegistry} --userconfig ${npmrc} --no-workspaces`
+
+  const npmrc =  tempy.temporaryFile({name: '.npmrc'})
+  await fs.writeFile(npmrc, `${npmRegistry.replace(/^https?:\/\//, '//')}/:_authToken=${npmToken}`, {encoding: 'utf8'})
+
+  return npmrc
 }
 
 // $`npm view ${name}@${version} dist.tarball`

package/src/main/js/processor.js

@@ -99,7 +99,7 @@ const createContext = async ({flags, env, cwd}) => {
 }
 
 // Inspired by https://docs.github.com/en/actions/learn-github-actions/contexts
-const contextify = async (pkg, {packages, root}) => {
+const contextify = async (pkg, {packages, root, flags}) => {
   pkg.config = await getPkgConfig(pkg.absPath, root.absPath)
   pkg.latest = await getLatest(pkg)
   pkg.context = {
@@ -108,6 +108,7 @@ const contextify = async (pkg, {packages, root}) => {
       root: await getRoot(pkg.absPath)
     },
     env: $.env,
+    flags,
     packages
   }
 }
@@ -141,17 +142,19 @@ const publish = memoizeBy(async (pkg, run = runCmd) => within(async () => {
     throw new Error('package.json version not synced')
   }
 
-  fs.writeJsonSync(pkg.manifestPath, pkg.manifest, {spaces: 2})
-  await pushReleaseTag(pkg)
-
-  await Promise.all([
-    pushMeta(pkg),
-    pushChangelog(pkg),
-    npmPublish(pkg),
-    ghRelease(pkg),
-    ghPages(pkg),
-    run(pkg, 'publishCmd')
-  ])
+  if (pkg.context.flags.snapshot) {
+    await npmPublish(pkg)
+  } else {
+    await pushReleaseTag(pkg)
+    await Promise.all([
+      pushMeta(pkg),
+      pushChangelog(pkg),
+      npmPublish(pkg),
+      ghRelease(pkg),
+      ghPages(pkg),
+      run(pkg, 'publishCmd')
+    ])
+  }
 
   pkg.published = true
 }))