@orderly.network/npm-release 0.0.3 → 0.0.4-alpha.0

package/README.md

@@ -2,7 +2,16 @@
 
 CLI for releasing npm packages using [release-it](https://github.com/release-it/release-it), with support for environment-based registry/token config, Git auth, pre-release tags, and Slack notifications.
 
-## Usage
+## Features
+
+- **release-it driven** — Bump version, commit, tag, and publish via release-it.
+- **Environment-based config** — Registry URL and npm token via `NPM_REGISTRY` / `NPM_TOKEN`; no local `.release-it.json` required.
+- **Git authentication** — GitLab (and similar) push via `GIT_TOKEN` + `GIT_USERNAME`; commit identity via `GIT_NAME` / `GIT_EMAIL`.
+- **Pre-release tags** — Optional `PRERELEASE_TAG` (e.g. `alpha`, `beta`) for prerelease versions and `npm dist-tag`.
+- **Slack notifications** — Optional webhook for success/failure after publish.
+- **Internal registry friendly** — When using a custom registry (non-npmjs.org), git tag creation is skipped so internal flows stay simple.
+
+## Installation and usage
 
 From your project root:
 
@@ -37,3 +46,38 @@ pnpm add -D @orderly.network/npm-release
 | `RELEASE_VERSION_TYPE` | Bump type: `patch`, `minor`, or `major`                                               |
 | `PRERELEASE_TAG`       | Pre-release identifier (e.g. `alpha`, `beta`); enables `--preRelease` and `--npm.tag` |
 | `SLACK_WEBHOOK_URL`    | Webhook URL for success/failure Slack notifications                                   |
+
+All variables are optional. Unset values use defaults or disable the corresponding feature (e.g. no Slack notification if `SLACK_WEBHOOK_URL` is not set).
+
+## Behavior
+
+### Internal registry
+
+When `NPM_REGISTRY` is set and is **not** `https://registry.npmjs.org`, the CLI treats it as an internal registry and **does not create a git tag**. Commits and push still occur; only tagging is skipped.
+
+### Pre-release
+
+- If `PRERELEASE_TAG` is set and the current `package.json` version is already a prerelease with the same preId (e.g. `1.0.0-alpha.0` with tag `alpha`), the version is incremented as **prerelease** (e.g. `1.0.0-alpha.1`).
+- Otherwise, the bump follows `RELEASE_VERSION_TYPE` (`patch`, `minor`, or `major`). When `PRERELEASE_TAG` is set, the new version is a prerelease and published under that npm dist-tag.
+
+### Working directory
+
+The CLI does **not** require a clean working directory. It is intended to run in CI after `pnpm install` or build steps that may change the lockfile or generated files.
+
+## CI integration
+
+In GitLab CI (or similar), set the needed environment variables (`GIT_NAME`, `GIT_EMAIL`, `GIT_USERNAME`, `GIT_TOKEN`, `NPM_REGISTRY`, `NPM_TOKEN`, `RELEASE_VERSION_TYPE`, `PRERELEASE_TAG`, `SLACK_WEBHOOK_URL`) and run:
+
+```bash
+pnpm release
+```
+
+or:
+
+```bash
+npx @orderly.network/npm-release
+```
+
+## License
+
+MIT

package/index.mjs

@@ -11,12 +11,14 @@ const npm = {
   token: process.env.NPM_TOKEN,
 };
 
-// Internal registry = custom registry (not public npm); skip git tag/push for internal
+// Internal registry = custom registry (not public npm)
 const isInternalRegistry = Boolean(
   npm.registry &&
     npm.registry.replace(/\/$/, "") !== "https://registry.npmjs.org"
 );
 
+const isPublicRegistry = !isInternalRegistry;
+
 const git = {
   name: process.env.GIT_NAME,
   email: process.env.GIT_EMAIL,
@@ -24,6 +26,9 @@ const git = {
   token: process.env.GIT_TOKEN,
 };
 
+// Current branch in CI environment
+const ciBranch = process.env.CI_COMMIT_BRANCH;
+
 const preReleaseTag = process.env.PRERELEASE_TAG;
 
 // Custom release version type (patch, minor, major)
@@ -34,7 +39,7 @@ const RELEASE_IT_CONFIG = {
   ci: true,
   git: {
     commit: true,
-    tag: !isInternalRegistry,
+    tag: isPublicRegistry,
     push: true,
     // Allow release when working dir is not clean so it works as a third-party package in CI
     // (e.g. after npm install or build steps that touch lockfile or generated files).
@@ -131,10 +136,6 @@ async function sendSlackNotify({ success, error }) {
   }
 }
 
-function sanitizePreId(id) {
-  return String(id).replaceAll("/", "-");
-}
-
 /**
  * Extract the repository path (owner/name) from the git remote origin URL.
  * Supports HTTPS and SSH URLs for GitHub and GitLab.
@@ -201,6 +202,30 @@ async function authNPM() {
   await $`echo ${content} >> .npmrc`;
 }
 
+async function getCurrentBranch() {
+  let branch = ciBranch;
+  if (!branch) {
+    try {
+      branch =
+        (await $`git rev-parse --abbrev-ref HEAD`.quiet()).stdout?.trim() || "";
+    } catch {
+      branch = "";
+    }
+  }
+  return branch;
+}
+
+/**
+ * get pre release tag from branch name for internal/* branches (e.g. internal/dev => dev)
+ */
+async function getPreReleaseTag() {
+  const branch = await getCurrentBranch();
+  if (branch.startsWith("internal/")) {
+    return branch.replace(/^internal\//, "");
+  }
+  return defaultTag;
+}
+
 /**
  * When current version is already a pre-release (e.g. 1.0.0-alpha.0) and PRERELEASE_TAG
  * matches the same preId (e.g. "alpha"), use increment "prerelease" so release-it bumps
@@ -208,14 +233,15 @@ async function authNPM() {
  * Returns options for release-it programmatic API (merged with RELEASE_IT_CONFIG).
  */
 async function getReleaseItOptions() {
+  const preTag = preReleaseTag || (await getPreReleaseTag());
+
   let increment = releaseVersionType;
 
-  if (preReleaseTag) {
+  if (preTag) {
     const currentVersion = readPackageVersion();
     const { isPrerelease, preId } = parseVersion(currentVersion);
-    const normalizedPreTag = sanitizePreId(preReleaseTag);
     // Continue pre-release: alpha.0 -> alpha.1 (same preId)
-    if (isPrerelease && preId === normalizedPreTag) {
+    if (isPrerelease && preId === preTag) {
       increment = "prerelease";
     }
   }
@@ -225,9 +251,9 @@ async function getReleaseItOptions() {
     increment,
   };
 
-  if (preReleaseTag) {
-    options.preRelease = preReleaseTag;
-    options.npm.tag = preReleaseTag;
+  if (preTag) {
+    options.preRelease = preTag;
+    options.npm.tag = preTag;
   }
 
   return options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orderly.network/npm-release",
-  "version": "0.0.3",
+  "version": "0.0.4-alpha.0",
   "main": "index.mjs",
   "module": "index.mjs",
   "license": "MIT",