zx-based alternative for multi-semantic-release
🚧 Work in progress. Early access preview
- Conventional commits trigger semantic releases.
- Automated cross-pkg version bumping.
- Predictable toposort-driven flow.
- No default branch blocking (no release commits).
- Pkg changelogs go to
changelogbranch (configurable). - Docs are published to
gh-pagesbranch (configurable). - No extra builds. The required deps are fetched from the pkg registry (
npmFetchconfig opt).
- Multistack. Add support for java/kt/py.
- Self-repair. Restore broken/missing metadata from external registries (npm, pypi, m2).
- Semaphore. Let several release agents to serve the monorepo at the same time.
- Stats. Store release metrics to
meta.
- macOS / linux
- Node.js >= 16.0.0
- npm >=7 / yarn >= 3
yarn add zx-bulk-releaseGH_TOKEN=ghtoken GH_USER=username NPM_TOKEN=npmtoken npx zx-bulk-release [opts]| Flag | Description | Default |
|---|---|---|
--dry-run |
Dry run mode | false |
--ignore |
Packages to ignore: a, b |
|
--include-private |
Include private pkgs | false |
import { run } from 'zx-bulk-release'
const cwd = '/foo/bar'
const env = {GH_TOKEN: 'foo', NPM_TOKEN: 'bar'}
const flags = {dryRun: true}
await run({
cwd, // Defaults to process.cwd()
flags, // Defaults to process.env
env // Defaults to minimist-parsed `process.argv.slice(2)`
})Any cosmiconfig compliant format: .releaserc, .release.json, .release.yaml, etc.
{
"cmd": "yarn && yarn build && yarn test",
"npmFetch": true,
"changelog": "changelog",
"ghPages": "gh-pages"
}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 [try {
const {packages, queue, root} = await topo({cwd, flags})
console.log('queue:', queue)
for (let name of queue) {
const pkg = packages[name]
await analyze(pkg, packages, root)
if (pkg.changes.length === 0) continue
await build(pkg, packages)
if (flags.dryRun) continue
await publish(pkg)
}
} catch (e) {
console.error(e)
throw e
}Toposort is used to resolve the pkg release queue.
By default, it omits the packages marked as private. You can override this by setting the --include-private flag.
Determines pkg changes, release type, next version etc.
export const analyze = async (pkg, packages, root) => {
pkg.config = await getConfig(pkg.absPath, root.absPath)
pkg.latest = await getLatest(pkg)
const semanticChanges = await getSemanticChanges(pkg.absPath, pkg.latest.tag?.ref)
const depsChanges = await updateDeps(pkg, packages)
const changes = [...semanticChanges, ...depsChanges]
pkg.changes = changes
pkg.version = resolvePkgVersion(changes, pkg.latest.tag?.version || pkg.manifest.version)
pkg.manifest.version = pkg.version
console.log(`[${pkg.name}] semantic changes`, changes)
}Applies config.cmd to build pkg assets: bundles, docs, etc.
export const build = async (pkg, packages) => {
// ...
if (!pkg.fetched && config.cmd) {
console.log(`[${pkg.name}] run cmd '${config.cmd}'`)
await $.o({cwd: pkg.absPath, quote: v => v})`${config.cmd}`
}
// ...
}Publish the pkg to git, npm, gh-pages, gh-release, etc.
export const publish = async (pkg) => {
await fs.writeJson(pkg.manifestPath, pkg.manifest, {spaces: 2})
await pushTag(pkg)
await pushMeta(pkg)
await pushChangelog(pkg)
await npmPublish(pkg)
await ghRelease(pkg)
await ghPages(pkg)
}Lerna tags (like @pkg/[email protected]) are suitable for monorepos, but they don’t follow semver spec. Therefore, we propose another contract:
'2022.6.13-optional-org.pkg-name.v1.0.0-beta.1+sha.1-f0'
// date name version formatNote, npm-package-name charset is wider than semver, so we need a pinch of base64url magic for some cases.
'2022.6.13-examplecom.v1.0.0.ZXhhbXBsZS5jb20-f1'
// date name ver b64 formatexport 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 || '[email protected]',
}
}Each release projects its result into the meta branch.
2022-6-26-semrel-extra-zxbr-test-c-1-3-1-f0.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"
}
}