zx-bulk-release 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [2.7.0](https://github.com/semrel-extra/zx-bulk-release/compare/v2.6.1...v2.7.0) (2023-04-30)
+
+### Fixes & improvements
+* fix: fix `latestVersion` fallback value ([9d25129](https://github.com/semrel-extra/zx-bulk-release/commit/9d25129dcf41c74cdd2d0670e86d20a32f7734c0))
+
+### Features
+* feat: let `releaseRules` be configured via opts ([4ae4606](https://github.com/semrel-extra/zx-bulk-release/commit/4ae4606678d13cf619e36861ce889e4e73c8a370))
+
+## [2.6.1](https://github.com/semrel-extra/zx-bulk-release/compare/v2.6.0...v2.6.1) (2023-04-21)
+
+### Fixes & improvements
+* docs: readme struct edits, mention `wget` and `git` as requirements ([2f76f12](https://github.com/semrel-extra/zx-bulk-release/commit/2f76f12b142a700dd53045fc4d268d6d8e64b721))
+
 ## [2.6.0](https://github.com/semrel-extra/zx-bulk-release/compare/v2.5.3...v2.6.0) (2023-04-21)
 
 ### Features

package/README.md

@@ -25,6 +25,9 @@
 * macOS / linux
 * Node.js >= 16.0.0
 * npm >=7 / yarn >= 3
+* wget
+* tar
+* git
 
 ## Usage
 ### Install
@@ -63,23 +66,9 @@ await run({
 })
 ```
 
-### ENV
-```ts
-export const parseEnv = ({GH_USER, GH_USERNAME, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, NPM_PROVENANCE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = process.env) =>
-  ({
-    ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
-    ghToken:            GH_TOKEN || GITHUB_TOKEN,
-    npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
-    npmToken:           NPM_TOKEN,
-    npmProvenance:      NPM_PROVENANCE,
-    npmRegistry:        NPM_REGISTRY || 'https://registry.npmjs.org',
-    gitCommitterName:   GIT_COMMITTER_NAME || 'Semrel Extra Bot',
-    gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
-  })
-```
-
-### Config
-Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format: `.releaserc`, `.release.json`, `.release.yaml`, etc.
+## Config
+### cosmiconfig
+Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format: `.releaserc`, `.release.json`, `.release.yaml`, etc in the package root or in the repo root dir.
 ```json
 {
   "cmd": "yarn && yarn build && yarn test",
@@ -89,51 +78,29 @@ Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format
 }
 ```
 
-### Demo
-* [demo-zx-bulk-release](https://github.com/semrel-extra/demo-zx-bulk-release)
-* [qiwi/pijma](https://github.com/qiwi/pijma)
-
-### Output
-
-[Compact and clear logs](https://github.com/semrel-extra/demo-zx-bulk-release/runs/7090161341?check_suite_focus=true#step:6:1)
+### 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, NPM_PROVENANCE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = env
 
-```shell
-Run npm_config_yes=true npx zx-bulk-release
-zx-bulk-release
-[@semrel-extra/zxbr-test-a] semantic changes [
-  {
-    group: 'Fixes & improvements',
-    releaseType: 'patch',
-    change: 'fix(a): random',
-    subj: 'fix(a): random',
-    body: '',
-    short: '6ff25bd',
-    hash: '6ff25bd421755b929ef2b58f35c727670fd93849'
-  }
-]
-[@semrel-extra/zxbr-test-a] run cmd 'yarn && yarn build && yarn test'
-[@semrel-extra/zxbr-test-a] push release tag 2022.6.27-semrel-extra.zxbr-test-a.1.8.1-f0
-[@semrel-extra/zxbr-test-a] push artifact to branch 'meta'
-[@semrel-extra/zxbr-test-a] push changelog
-[@semrel-extra/zxbr-test-a] publish npm package @semrel-extra/zxbr-test-a 1.8.1 to https://registry.npmjs.org
-[@semrel-extra/zxbr-test-a] create gh release
-[@semrel-extra/zxbr-test-b] semantic changes [
-  {
-    group: 'Dependencies',
-    releaseType: 'patch',
-    change: 'perf',
-    subj: 'perf: @semrel-extra/zxbr-test-a updated to 1.8.1'
+  return {
+    ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
+    ghToken:            GH_TOKEN || GITHUB_TOKEN,
+    npmToken:           NPM_TOKEN,
+    // npmConfig suppresses npmToken
+    npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
+    npmRegistry:        NPM_REGISTRY || 'https://registry.npmjs.org',
+    npmProvenance:      NPM_PROVENANCE,
+    gitCommitterName:   GIT_COMMITTER_NAME || 'Semrel Extra Bot',
+    gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
   }
-]
-[@semrel-extra/zxbr-test-b] run cmd 'yarn && yarn build && yarn test'
-[@semrel-extra/zxbr-test-b] push release tag 2022.6.27-semrel-extra.zxbr-test-b.1.3.5-f0
-[@semrel-extra/zxbr-test-b] push artifact to branch 'meta'
-[@semrel-extra/zxbr-test-b] push changelog
-[@semrel-extra/zxbr-test-b] publish npm package @semrel-extra/zxbr-test-b 1.3.5 to https://registry.npmjs.org
-[@semrel-extra/zxbr-test-b] create gh release
-[@semrel-extra/zxbr-test-d] semantic changes [
+}
 ```
 
+## Demo
+* [demo-zx-bulk-release](https://github.com/semrel-extra/demo-zx-bulk-release)
+* [qiwi/pijma](https://github.com/qiwi/pijma)
+
 ## Implementation notes
 ### Flow
 ```js
@@ -184,6 +151,15 @@ export const analyze = async (pkg, packages, root) => {
 }
 ```
 
+Set `config.releaseRules` to override the default rules preset:
+```ts
+[
+  {group: 'Features', releaseType: 'minor', prefixes: ['feat']},
+  {group: 'Fixes & improvements', releaseType: 'patch', prefixes: ['fix', 'perf', 'refactor', 'docs', 'patch']},
+  {group: 'BREAKING CHANGES', releaseType: 'major', keywords: ['BREAKING CHANGE', 'BREAKING CHANGES']},
+]
+```
+
 ### `build`
 Applies `config.cmd` to build pkg assets: bundles, docs, etc.
 ```js
@@ -223,25 +199,6 @@ Note, [npm-package-name charset](https://www.npmjs.com/package/validate-npm-pack
 // date    name       ver    b64             format
 ```
 
-### 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
-
-  return {
-    ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
-    ghToken:            GH_TOKEN || GITHUB_TOKEN,
-    npmToken:           NPM_TOKEN,
-    // npmConfig suppresses npmToken
-    npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
-    npmRegistry:        NPM_REGISTRY || 'https://registry.npmjs.org',
-    gitCommitterName:   GIT_COMMITTER_NAME || 'Semrel Extra Bot',
-    gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
-  }
-}
-```
-
 ### Meta
 
 Each release stores its result into the `meta` branch.  
@@ -305,6 +262,46 @@ Release process state is reported to the console and to a file if `--report` fla
 }
 ```
 
+### Output
+[Compact and clear logs](https://github.com/semrel-extra/demo-zx-bulk-release/runs/7090161341?check_suite_focus=true#step:6:1)
+
+```shell
+Run npm_config_yes=true npx zx-bulk-release
+zx-bulk-release
+[@semrel-extra/zxbr-test-a] semantic changes [
+  {
+    group: 'Fixes & improvements',
+    releaseType: 'patch',
+    change: 'fix(a): random',
+    subj: 'fix(a): random',
+    body: '',
+    short: '6ff25bd',
+    hash: '6ff25bd421755b929ef2b58f35c727670fd93849'
+  }
+]
+[@semrel-extra/zxbr-test-a] run cmd 'yarn && yarn build && yarn test'
+[@semrel-extra/zxbr-test-a] push release tag 2022.6.27-semrel-extra.zxbr-test-a.1.8.1-f0
+[@semrel-extra/zxbr-test-a] push artifact to branch 'meta'
+[@semrel-extra/zxbr-test-a] push changelog
+[@semrel-extra/zxbr-test-a] publish npm package @semrel-extra/zxbr-test-a 1.8.1 to https://registry.npmjs.org
+[@semrel-extra/zxbr-test-a] create gh release
+[@semrel-extra/zxbr-test-b] semantic changes [
+  {
+    group: 'Dependencies',
+    releaseType: 'patch',
+    change: 'perf',
+    subj: 'perf: @semrel-extra/zxbr-test-a updated to 1.8.1'
+  }
+]
+[@semrel-extra/zxbr-test-b] run cmd 'yarn && yarn build && yarn test'
+[@semrel-extra/zxbr-test-b] push release tag 2022.6.27-semrel-extra.zxbr-test-b.1.3.5-f0
+[@semrel-extra/zxbr-test-b] push artifact to branch 'meta'
+[@semrel-extra/zxbr-test-b] push changelog
+[@semrel-extra/zxbr-test-b] publish npm package @semrel-extra/zxbr-test-b 1.3.5 to https://registry.npmjs.org
+[@semrel-extra/zxbr-test-b] create gh release
+[@semrel-extra/zxbr-test-d] semantic changes [
+```
+
 ## References
 * [semrel-extra/zx-semrel](https://github.com/semrel-extra/zx-semrel)
 * [dhoulb/multi-semantic-release](https://github.com/dhoulb/multi-semantic-release)
@@ -323,6 +320,7 @@ Release process state is reported to the console and to a file if `--report` fla
 * [moonrepo/moon](https://github.com/moonrepo/moon)
 * [ojkelly/yarn.build](https://github.com/ojkelly/yarn.build)
 * [antfu/bumpp](https://github.com/antfu/bumpp)
+* [googleapis/release-please](https://github.com/googleapis/release-please)
 
 ## License 
 [MIT](./LICENSE)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zx-bulk-release",
   "alias": "bulk-release",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": {
@@ -31,7 +31,7 @@
   "devDependencies": {
     "c8": "^7.13.0",
     "uvu": "^0.5.6",
-    "verdaccio": "^5.23.2"
+    "verdaccio": "^5.24.1"
   },
   "publishConfig": {
     "access": "public"

package/src/main/js/analyze.js

@@ -5,12 +5,12 @@ import {log} from './log.js'
 import {getCommits} from './git.js'
 
 export const analyze = async (pkg) => {
-  const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
+  const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref, undefined, pkg.config.releaseRules)
   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
-  const latestVersion = pkg.latest.tag?.version || pkg.latest.meta?.versio
+  const latestVersion = pkg.latest.tag?.version || pkg.latest.meta?.version
 
   pkg.changes = changes
   pkg.releaseType = releaseType
@@ -34,15 +34,15 @@ export const semanticRules = [
   {group: 'BREAKING CHANGES', releaseType: 'major', keywords: ['BREAKING CHANGE', 'BREAKING CHANGES']},
 ]
 
-export const getSemanticChanges = async (cwd, from, to) => {
+export const getSemanticChanges = async (cwd, from, to, rules = semanticRules) => {
   const commits = await getCommits(cwd, from, to)
 
-  return analyzeCommits(commits)
+  return analyzeCommits(commits, rules)
 }
 
-export const analyzeCommits = (commits) =>
+export const analyzeCommits = (commits, rules) =>
   commits.reduce((acc, {subj, body, short, hash}) => {
-    semanticRules.forEach(({group, releaseType, prefixes, keywords}) => {
+    rules.forEach(({group, releaseType, prefixes, keywords}) => {
       const prefixMatcher = prefixes && new RegExp(`^(${prefixes.join('|')})(\\([a-z0-9\\-_,]+\\))?:\\s.+$`)
       const keywordsMatcher = keywords && new RegExp(`(${keywords.join('|')}):\\s(.+)`)
       const change = subj.match(prefixMatcher)?.[0] || body.match(keywordsMatcher)?.[2]

package/src/main/js/config.js

@@ -31,6 +31,7 @@ export const getPkgConfig = async (...cwds) =>
 export const normalizePkgConfig = (config, env) => ({
   ...parseEnv(env),
   ...config,
+  releaseRules: config.releaseRules || config.semanticRules,
   npmFetch: config.npmFetch || config.fetch || config.fetchPkg,
   buildCmd: config.buildCmd || config.cmd,
   get ghBasicAuth() {