zx-bulk-release 2.19.1 → 2.20.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [2.20.0](https://github.com/semrel-extra/zx-bulk-release/compare/v2.19.1...v2.20.0) (2026-04-05)
+
+### Features
+* feat: support custom ghe urls (#89) ([e33d53c](https://github.com/semrel-extra/zx-bulk-release/commit/e33d53cfe4ac15d8fd66785622d9df428a15d8e6))
+
 ## [2.19.1](https://github.com/semrel-extra/zx-bulk-release/compare/v2.19.0...v2.19.1) (2026-04-05)
 
 ### Fixes & improvements

package/README.md

@@ -77,18 +77,40 @@ Any [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) compliant format
   "cmd": "yarn && yarn build && yarn test",
   "npmFetch": true,
   "changelog": "changelog",
-  "ghPages": "gh-pages"
+  "ghPages": "gh-pages",
+  "diffTagUrl": "${repoPublicUrl}/compare/${prevTag}...${newTag}",
+  "diffCommitUrl": "${repoPublicUrl}/commit/${hash}"
 }
 ```
 
+#### Changelog diff URLs
+By default, changelog entries link to GitHub compare/commit pages. Override `diffTagUrl` and `diffCommitUrl` to customize for other platforms (e.g. Gerrit):
+```json
+{
+  "diffTagUrl": "https://gerrit.foo.com/plugins/gitiles/${repoName}/+/refs/tags/${newTag}",
+  "diffCommitUrl": "https://gerrit.foo.com/plugins/gitiles/${repoName}/+/${hash}%5E%21"
+}
+```
+Available variables: `repoName`, `repoPublicUrl`, `prevTag`, `newTag`, `name`, `version`, `hash`, `short`.
+
+#### GitHub Enterprise
+Set `ghUrl` to point to your GHE instance. API URL (`ghApiUrl`) is derived automatically.
+```json
+{
+  "ghUrl": "https://ghe.corp.com"
+}
+```
+Or via env: `GH_URL=https://ghe.corp.com` / `GITHUB_URL=https://ghe.corp.com`.
+
 ### 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, NPM_OIDC, ACTIONS_ID_TOKEN_REQUEST_URL, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = env
+  const {GH_USER, GH_USERNAME, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, GH_URL, GITHUB_URL, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, NPM_PROVENANCE, NPM_OIDC, ACTIONS_ID_TOKEN_REQUEST_URL, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = env
 
   return {
-    ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME,
+    ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME || 'x-access-token',
     ghToken:            GH_TOKEN || GITHUB_TOKEN,
+    ghUrl:              GH_URL || GITHUB_URL || 'https://github.com',
     npmToken:           NPM_TOKEN,
     // npmConfig suppresses npmToken
     npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zx-bulk-release",
   "alias": "bulk-release",
-  "version": "2.19.1",
+  "version": "2.20.0",
   "description": "zx-based alternative for multi-semantic-release",
   "type": "module",
   "exports": {

package/src/main/js/api/changelog.js

@@ -21,14 +21,27 @@ export const pushChangelog = queuefy(async (pkg) => {
   await pushCommit({cwd, branch, msg, gitCommitterEmail, gitCommitterName, basicAuth})
 })
 
+export const DIFF_TAG_URL = '${repoPublicUrl}/compare/${prevTag}...${newTag}'
+export const DIFF_COMMIT_URL = '${repoPublicUrl}/commit/${hash}'
+
+export const interpolate = (template, vars) => {
+  const result = template.replace(/\$\{(\w+)}/g, (_, key) => vars[key] ?? '')
+  try { new URL(result) } catch { throw new Error(`invalid URL after interpolation: '${result}' (template: '${template}')`) }
+  return result
+}
+
 export const formatReleaseNotes = async (pkg) => {
-  const {name, version, tag = formatTag({name, version}), absPath: cwd, config: {ghBasicAuth: basicAuth}} = pkg
-  const {repoPublicUrl} = await getRepo(cwd, {basicAuth})
-  const releaseDiffRef = `## [${name}@${version}](${repoPublicUrl}/compare/${pkg.latest.tag?.ref}...${tag}) (${new Date().toISOString().slice(0, 10)})`
+  const {name, version, tag = formatTag({name, version}), absPath: cwd, config: {ghBasicAuth: basicAuth, diffTagUrl = DIFF_TAG_URL, diffCommitUrl = DIFF_COMMIT_URL}} = pkg
+  const {repoPublicUrl, repoName} = await getRepo(cwd, {basicAuth})
+  const prevTag = pkg.latest.tag?.ref
+  const vars = {repoName, repoPublicUrl, prevTag, newTag: tag, name, version}
+  const diffUrl = interpolate(diffTagUrl, vars)
+  const releaseDiffRef = `## [${name}@${version}](${diffUrl}) (${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})` : ''}`
+      const commitUrl = interpolate(diffCommitUrl, {...vars, hash, short})
+      const commitRef = `* ${subj}${short ? ` [${short}](${commitUrl})` : ''}`
 
       commits.push(commitRef)
 

package/src/main/js/api/gh.js

@@ -8,7 +8,7 @@ import {asArray, getCommonPath, msgJoin} from '../util.js'
 
 // https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
 export const ghRelease = async (pkg) => {
-  const {ghBasicAuth: basicAuth, ghToken, ghAssets} = pkg.config
+  const {ghBasicAuth: basicAuth, ghToken, ghAssets, ghApiUrl} = pkg.config
   if (!ghToken) return null
 
   log({pkg})('create gh release')
@@ -23,7 +23,7 @@ export const ghRelease = async (pkg) => {
     body: releaseNotes
   })
 
-  const res = await (await fetch(`https://api.github.com/repos/${repoName}/releases`, {
+  const res = await (await fetch(`${ghApiUrl}/repos/${repoName}/releases`, {
     method: 'POST',
     headers: {
       Accept: 'application/vnd.github.v3+json',
@@ -122,8 +122,8 @@ export const ghUploadAssets = async ({ghToken, ghAssets, uploadUrl, cwd}) => {
   }))
 }
 
-export const ghGetAsset = async ({repoName, tag, name}) => {
-  return (await fetch(`https://github.com/${repoName}/releases/download/${tag.ref || tag}/${name}`, {
+export const ghGetAsset = async ({repoName, tag, name, ghUrl}) => {
+  return (await fetch(`${ghUrl || 'https://github.com'}/${repoName}/releases/download/${tag.ref || tag}/${name}`, {
     headers: {
       // Accept: 'application/vnd.github.v3+json'
     }

package/src/main/js/config.js

@@ -58,10 +58,18 @@ export const normalizeMetaConfig = (meta) =>
         ? { type: meta } // 'commit' | 'asset' | 'tag'
         : { type: null }
 
-export const parseEnv = ({GH_USER, GH_USERNAME, GH_META, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, NPM_PROVENANCE, NPM_OIDC, ACTIONS_ID_TOKEN_REQUEST_URL, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = process.env) =>
-  ({
+export const GH_URL = 'https://github.com'
+
+const resolveGhApiUrl = (ghUrl) =>
+  ghUrl === GH_URL ? 'https://api.github.com' : `${ghUrl.replace(/\/$/, '')}/api/v3`
+
+export const parseEnv = ({GH_USER, GH_USERNAME, GH_META, GH_URL: _GH_URL, GITHUB_URL, GITHUB_USER, GITHUB_USERNAME, GH_TOKEN, GITHUB_TOKEN, NPM_TOKEN, NPM_REGISTRY, NPMRC, NPM_USERCONFIG, NPM_CONFIG_USERCONFIG, NPM_PROVENANCE, NPM_OIDC, ACTIONS_ID_TOKEN_REQUEST_URL, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL} = process.env) => {
+  const ghUrl = _GH_URL || GITHUB_URL || GH_URL
+  return {
     ghUser:             GH_USER || GH_USERNAME || GITHUB_USER || GITHUB_USERNAME || ((GH_TOKEN || GITHUB_TOKEN) ? 'x-access-token' : undefined),
     ghToken:            GH_TOKEN || GITHUB_TOKEN,
+    ghUrl,
+    ghApiUrl:           resolveGhApiUrl(ghUrl),
     ghMeta:             GH_META,
     npmConfig:          NPMRC || NPM_USERCONFIG || NPM_CONFIG_USERCONFIG,
     npmToken:           NPM_TOKEN,
@@ -70,6 +78,7 @@ export const parseEnv = ({GH_USER, GH_USERNAME, GH_META, GITHUB_USER, GITHUB_USE
     npmRegistry:        NPM_REGISTRY || 'https://registry.npmjs.org',
     gitCommitterName:   GIT_COMMITTER_NAME || 'Semrel Extra Bot',
     gitCommitterEmail:  GIT_COMMITTER_EMAIL || 'semrel-extra-bot@hotmail.com',
-  })
+  }
+}
 
 export const normalizeFlags = (flags = {}) => Object.entries(flags).reduce((acc, [k, v]) => ({...acc, [camelize(k)]: v}), {})

package/src/main/js/processor/meta.js

@@ -217,11 +217,11 @@ export const getArtifactPath = (tag) => tag.toLowerCase().replace(/[^a-z0-9-]/g,
 
 export const getLatestMeta = async (pkg, tag) => {
   if (tag) {
-    const {absPath: cwd, config: {ghBasicAuth: basicAuth}} = pkg
+    const {absPath: cwd, config: {ghBasicAuth: basicAuth, ghUrl}} = pkg
     const {repoName} = await getRepo(cwd, {basicAuth})
 
     try {
-      return JSON.parse(await ghGetAsset({repoName, tag, name: 'meta.json'}))
+      return JSON.parse(await ghGetAsset({repoName, tag, name: 'meta.json', ghUrl}))
     } catch {}
 
     try {

package/src/main/js/steps/contextify.js

@@ -28,7 +28,7 @@ export const rollbackRelease = async (pkg) => {
   if (!tag) return
 
   const cwd = pkg.context.git.root
-  const {ghBasicAuth: basicAuth, ghToken, gitCommitterName, gitCommitterEmail} = pkg.config
+  const {ghBasicAuth: basicAuth, ghToken, ghApiUrl, gitCommitterName, gitCommitterEmail} = pkg.config
   if (!basicAuth) throw new Error('rollback requires git credentials (GH_TOKEN)')
   const {repoName} = await getRepo(cwd, {basicAuth})
 
@@ -37,12 +37,12 @@ export const rollbackRelease = async (pkg) => {
   // 1. Delete GitHub release
   if (ghToken) {
     try {
-      const res = await fetch(`https://api.github.com/repos/${repoName}/releases/tags/${tag}`, {
+      const res = await fetch(`${ghApiUrl}/repos/${repoName}/releases/tags/${tag}`, {
         headers: {Authorization: `token ${ghToken}`, 'X-GitHub-Api-Version': '2022-11-28'}
       })
       if (res.ok) {
         const {id} = await res.json()
-        await fetch(`https://api.github.com/repos/${repoName}/releases/${id}`, {
+        await fetch(`${ghApiUrl}/repos/${repoName}/releases/${id}`, {
           method: 'DELETE',
           headers: {Authorization: `token ${ghToken}`, 'X-GitHub-Api-Version': '2022-11-28'}
         })
@@ -98,7 +98,7 @@ export const recover = async (pkg) => {
   if (manifest) return false
 
   const cwd = await getRoot(pkg.absPath)
-  const {ghBasicAuth: basicAuth, ghToken, gitCommitterName, gitCommitterEmail} = pkg.config
+  const {ghBasicAuth: basicAuth, ghToken, ghApiUrl, gitCommitterName, gitCommitterEmail} = pkg.config
   if (!basicAuth) throw new Error('recover requires git credentials (GH_TOKEN)')
   const {repoName} = await getRepo(cwd, {basicAuth})
 
@@ -107,12 +107,12 @@ export const recover = async (pkg) => {
   // 1. Delete GitHub release (also removes attached meta assets)
   if (ghToken) {
     try {
-      const res = await fetch(`https://api.github.com/repos/${repoName}/releases/tags/${tag.ref}`, {
+      const res = await fetch(`${ghApiUrl}/repos/${repoName}/releases/tags/${tag.ref}`, {
         headers: {Authorization: `token ${ghToken}`, 'X-GitHub-Api-Version': '2022-11-28'}
       })
       if (res.ok) {
         const {id} = await res.json()
-        await fetch(`https://api.github.com/repos/${repoName}/releases/${id}`, {
+        await fetch(`${ghApiUrl}/repos/${repoName}/releases/${id}`, {
           method: 'DELETE',
           headers: {Authorization: `token ${ghToken}`, 'X-GitHub-Api-Version': '2022-11-28'}
         })