@orderly.network/npm-release 0.0.2-alpha.5

package/.gitlab-ci.yml

@@ -0,0 +1,4 @@
+include:
+  - project: "orderlynetwork/orderly-fe/js-sdks/common-ci"
+    ref: main
+    file: "/npm-release.yml"

package/README.md

@@ -0,0 +1,48 @@
+# @orderly.network/npm-release
+
+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
+
+From your project root:
+
+```bash
+npx @orderly.network/npm-release
+```
+
+Or add as a devDependency and run via scripts:
+
+```bash
+pnpm add -D @orderly.network/npm-release
+```
+
+```json
+{
+  "scripts": {
+    "release": "orderly-npm-release",
+    "release:patch": "RELEASE_VERSION_TYPE=patch orderly-npm-release",
+    "release:minor": "RELEASE_VERSION_TYPE=minor orderly-npm-release",
+    "release:major": "RELEASE_VERSION_TYPE=major orderly-npm-release"
+  }
+}
+```
+
+## Environment variables
+
+| Variable               | Description                                                                           |
+| ---------------------- | ------------------------------------------------------------------------------------- |
+| `NPM_REGISTRY`         | npm registry URL (default: `https://registry.npmjs.org`)                              |
+| `NPM_TOKEN`            | Auth token for publishing; written to `.npmrc` when set                               |
+| `GIT_TOKEN`            | Git personal access token for push (e.g. GitLab)                                      |
+| `GIT_USERNAME`         | Git username (used with token for authenticated remote URL)                           |
+| `GIT_NAME`             | Git `user.name` for commits                                                           |
+| `GIT_EMAIL`            | Git `user.email` for commits                                                          |
+| `GIT_COMMIT_MESSAGE`   | Optional custom commit message                                                        |
+| `RELEASE_VERSION_TYPE` | Bump type: `major`, `minor`, or `patch`                                               |
+| `CUSTOM_PRE_TAG`       | Pre-release identifier (e.g. `alpha`, `beta`); enables `--preRelease` and `--npm.tag` |
+| `SLACK_WEBHOOK_URL`    | Webhook URL for success/failure Slack notifications                                   |
+
+## Prerequisites
+
+- Your project must have a `package.json` with a valid `version`.
+- For publishing to npm, configure `.release-it.json` in your project (or rely on defaults). This package ships a default [.release-it.json](.release-it.json) you can copy or merge.

package/index.mjs

@@ -0,0 +1,247 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import { $ } from "zx";
+import releaseIt from "release-it";
+
+$.verbose = true;
+
+const npm = {
+  registry: process.env.NPM_REGISTRY,
+  token: process.env.NPM_TOKEN,
+};
+
+const git = {
+  token: process.env.GIT_TOKEN,
+  username: process.env.GIT_USERNAME,
+  name: process.env.GIT_NAME,
+  email: process.env.GIT_EMAIL,
+  commitMessage: process.env.GIT_COMMIT_MESSAGE,
+};
+
+const customPreTag = process.env.CUSTOM_PRE_TAG;
+
+// Custom release version type (major, minor, patch)
+const releaseVersionType = process.env.RELEASE_VERSION_TYPE;
+
+/** Inlined config (formerly .release-it.json) */
+const RELEASE_IT_CONFIG = {
+  ci: true,
+  git: {
+    commit: true,
+    tag: true,
+    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).
+    requireCleanWorkingDir: false,
+  },
+  npm: {
+    publish: true,
+    // Skip npm collaborator/registry checks so publishing works when used as a third-party
+    // package or with private registries that don't support whoami/access (actual publish
+    // still fails if the user lacks permission).
+    skipChecks: true,
+  },
+  github: {
+    release: false,
+  },
+};
+const slackWebhookUrl = process.env.SLACK_WEBHOOK_URL;
+
+function parseVersion(version) {
+  const m = /^(\d+\.\d+\.\d+)(?:-([0-9A-Za-z.-]+))?$/.exec(version);
+  if (!m) return { base: version, isPrerelease: false, preId: "" };
+  const base = m[1];
+  const pre = m[2] || "";
+  const preId = pre ? pre.split(".")[0] : "";
+  return { base, isPrerelease: Boolean(pre), preId };
+}
+
+function readPackageJson() {
+  const pkgPath = path.join(process.cwd(), "package.json");
+  return JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+}
+
+function readPackageVersion() {
+  const pkg = readPackageJson();
+  return String(pkg.version || "");
+}
+
+/**
+ * Send Slack notification via webhook.
+ * Called on both success and failure so CI/user gets notified either way.
+ * @param {object} opts
+ * @param {boolean} opts.success - whether release succeeded
+ * @param {string} [opts.version] - package version (after release on success)
+ * @param {string} [opts.error] - error message on failure
+ */
+
+/**
+ * Build package page URL for public or private npm registry.
+ * Public (no NPM_REGISTRY or registry.npmjs.org): https://www.npmjs.com/package/<name>
+ * Private: <registry>/-/web/detail/<name> (Verdaccio-style)
+ */
+function getPackagePageUrl(pkgName) {
+  const raw = npm.registry || "https://registry.npmjs.org";
+  const registry = raw.replace(/\/$/, "");
+  const isPublic = !npm.registry || registry === "https://registry.npmjs.org";
+  if (isPublic) {
+    return `https://www.npmjs.com/package/${encodeURIComponent(pkgName)}`;
+  }
+  return `${registry}/-/web/detail/${encodeURIComponent(pkgName)}`;
+}
+
+async function sendSlackNotify({ success, error }) {
+  if (!slackWebhookUrl) return;
+
+  const { name: pkgName, version } = readPackageJson();
+  const packageUrl = getPackagePageUrl(pkgName);
+  const linkedPkg = `<${packageUrl}|${pkgName}@${version}>`;
+  const text = success
+    ? `packages published successfully:\n${linkedPkg}`
+    : `packages publish failed:\n${linkedPkg}\n${error || "Unknown error"}`;
+
+  try {
+    const res = await fetch(slackWebhookUrl, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ text, mrkdwn: true }),
+    });
+    if (!res.ok) {
+      console.warn(
+        "[release] Slack notify failed:",
+        res.status,
+        await res.text()
+      );
+    }
+  } catch (e) {
+    console.warn("[release] Slack notify error:", e.message);
+  }
+}
+
+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.
+ * Examples:
+ * https://github.com/OrderlyNetwork/orderly-sdk-js.git => OrderlyNetwork/orderly-sdk-js
+ * git@github.com:OrderlyNetwork/orderly-sdk-js.git => OrderlyNetwork/orderly-sdk-js
+ */
+async function getRepoPath() {
+  const res = await $`git remote get-url origin`;
+  // console.log("getRepoPath: ", res);
+  const origin = res.stdout?.replace(/\s+/g, "");
+  const regex = /(?:github\.com|gitlab\.com)[:/](.+?\/.+?)\.git/;
+  const match = origin.match(regex);
+  const repoPath = match ? match[1] : null;
+  return repoPath;
+}
+
+/**
+ * Construct the remote git repository URL with authentication token if provided.
+ * Supports GitLab personal access token authentication format.
+ */
+async function getRemoteUrlWithToken() {
+  const repoPath = await getRepoPath();
+
+  if (git.token && git.username && repoPath) {
+    // Format: https://<username>:<token>@gitlab.com/<repoPath>.git
+    return `https://${git.username}:${git.token}@gitlab.com/${repoPath}.git`;
+  }
+
+  return "";
+}
+
+async function configureGit() {
+  if (git.name) await $`git config user.name ${git.name}`;
+  if (git.email) await $`git config user.email ${git.email}`;
+
+  const authedRemote = await getRemoteUrlWithToken();
+  if (authedRemote) {
+    await $`git remote set-url origin ${authedRemote}`;
+  }
+}
+
+function configureNpmEnv() {
+  // Prefer environment-driven registry (matches previous behavior: npm_config_registry).
+  if (npm.registry) {
+    process.env.npm_config_registry = npm.registry;
+  }
+
+  if (npm.token) {
+    process.env.NPM_TOKEN = npm.token;
+  }
+}
+
+/**
+ * Authenticate npm by appending an auth token to the local ~/.npmrc file.
+ * Uses custom registry if provided, defaults to public npm registry.
+ */
+async function authNPM() {
+  // Remove protocol from registry URL for .npmrc syntax
+  const registry = (npm.registry || "https://registry.npmjs.org")
+    .replace("http://", "")
+    .replace("https://", "");
+  const content = `\n//${registry}/:_authToken="${npm.token}"`;
+  await $`echo ${content} >> .npmrc`;
+}
+
+/**
+ * When current version is already a pre-release (e.g. 1.0.0-alpha.0) and CUSTOM_PRE_TAG
+ * matches the same preId (e.g. "alpha"), use increment "prerelease" so release-it bumps
+ * to 1.0.0-alpha.1. Otherwise use RELEASE_VERSION_TYPE (patch/minor/major).
+ * Returns options for release-it programmatic API (merged with RELEASE_IT_CONFIG).
+ */
+async function getReleaseItOptions() {
+  let increment = releaseVersionType;
+
+  if (customPreTag) {
+    const currentVersion = readPackageVersion();
+    const { isPrerelease, preId } = parseVersion(currentVersion);
+    const normalizedPreTag = sanitizePreId(customPreTag);
+    // Continue pre-release: alpha.0 -> alpha.1 (same preId)
+    if (isPrerelease && preId === normalizedPreTag) {
+      increment = "prerelease";
+    }
+  }
+
+  const options = {
+    ...RELEASE_IT_CONFIG,
+    increment,
+  };
+
+  if (customPreTag) {
+    options.preRelease = customPreTag;
+    options.npm.tag = customPreTag;
+  }
+
+  return options;
+}
+
+async function main() {
+  try {
+    // Authenticate with npm registry if token provided
+    if (npm.token) {
+      await authNPM();
+    }
+
+    configureNpmEnv();
+    await configureGit();
+
+    const releaseItOptions = await getReleaseItOptions();
+    await releaseIt(releaseItOptions);
+
+    await sendSlackNotify({ success: true });
+  } catch (err) {
+    await sendSlackNotify({
+      success: false,
+      error: err?.message,
+    });
+    throw err;
+  }
+}
+
+main();

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@orderly.network/npm-release",
+  "version": "0.0.2-alpha.5",
+  "main": "index.mjs",
+  "module": "index.mjs",
+  "license": "MIT",
+  "bin": {
+    "orderly-npm-release": "./index.mjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "release": "node index.mjs"
+  },
+  "dependencies": {
+    "release-it": "^19.2.4",
+    "zx": "^8.8.5"
+  }
+}