chore: add release script for version bumping and tagging

Author: khang-nd

README.md

@@ -60,11 +60,11 @@ Pushing changes under `docs/` to `main` triggers [`.github/workflows/deploy-docs
 
 ## Releasing
 
-Pushing a tag matching `v*` (e.g. `v1.1.0`) triggers [`.github/workflows/release.yml`](.github/workflows/release.yml), which type-checks, lints, and tests the project, sets `package.json`'s version to match the tag, builds & zips both the Chrome and Firefox extensions, and publishes them as assets on a GitHub Release (auto-generated release notes from commits/PRs since the last tag).
-
 ```sh
-git tag v1.1.0
-git push origin v1.1.0
+pnpm release          # prompts for the version
+pnpm release 1.2.0    # or pass it directly
 ```
 
-`package.json`'s `version` is the single source of truth for the extension version — `wxt.config.ts` intentionally has no `version` field, so the built manifest always reflects it (and the release workflow keeps it in sync with the tag).
+[`scripts/release.mjs`](scripts/release.mjs) bumps `package.json`'s `version`, commits it, tags it (`v<version>`), and pushes the commit + tag to `origin/main` (after confirming you're on `main`, the working tree is clean, and `main` is up to date with `origin/main`). Pushing the tag triggers [`.github/workflows/release.yml`](.github/workflows/release.yml), which type-checks, lints, and tests the project, builds & zips both the Chrome and Firefox extensions, publishes them as assets on a GitHub Release (auto-generated release notes from commits/PRs since the last tag), and commits an update to `docs/changelog.md`.
+
+`package.json`'s `version` is the single source of truth for the extension version — `wxt.config.ts` intentionally has no `version` field, so the built manifest always reflects it.

eslint.config.js

@@ -6,9 +6,16 @@ export default tseslint.config(
   js.configs.recommended,
   ...tseslint.configs.recommended,
   eslintConfigPrettier,
-  { ignores: ['.wxt/', '.output/', 'docs/.vitepress/cache/', 'docs/.vitepress/dist/'] },
   {
-    files: ['.github/scripts/**/*.mjs'],
+    ignores: [
+      '.wxt/',
+      '.output/',
+      'docs/.vitepress/cache/',
+      'docs/.vitepress/dist/',
+    ],
+  },
+  {
+    files: ['.github/scripts/**/*.mjs', 'scripts/**/*.mjs'],
     languageOptions: {
       globals: { process: 'readonly', console: 'readonly' },
     },

package.json

@@ -16,6 +16,7 @@
     "lint": "eslint .",
     "format": "prettier --write .",
     "test": "vitest run",
+    "release": "node scripts/release.mjs",
     "postinstall": "wxt prepare",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",

scripts/release.mjs

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+// Bumps package.json's version, commits it, tags it, and pushes — triggering
+// .github/workflows/release.yml. See README.md's "Releasing" section.
+import { execSync } from 'node:child_process';
+import { createInterface } from 'node:readline/promises';
+import { stdin, stdout } from 'node:process';
+
+function run(cmd) {
+  execSync(cmd, { stdio: 'inherit' });
+}
+
+function capture(cmd) {
+  return execSync(cmd, { encoding: 'utf8' }).trim();
+}
+
+async function prompt(question) {
+  const rl = createInterface({ input: stdin, output: stdout });
+  try {
+    return (await rl.question(question)).trim();
+  } finally {
+    rl.close();
+  }
+}
+
+async function main() {
+  const branch = capture('git rev-parse --abbrev-ref HEAD');
+  if (branch !== 'main') {
+    throw new Error(`Refusing to release from branch "${branch}" — switch to main first.`);
+  }
+
+  if (capture('git status --porcelain')) {
+    throw new Error('Working tree is not clean — commit or stash changes before releasing.');
+  }
+
+  run('git fetch origin main --quiet');
+  if (capture('git rev-list HEAD..origin/main --count') !== '0') {
+    throw new Error('Local main is behind origin/main — pull before releasing.');
+  }
+
+  let version = process.argv[2] ?? (await prompt('Enter release version (e.g. 1.2.0): '));
+  version = version.replace(/^v/, '').trim();
+  if (!/^\d+\.\d+\.\d+(-[0-9A-Za-z-.]+)?$/.test(version)) {
+    throw new Error(`Invalid version "${version}" — expected semver like 1.2.0`);
+  }
+
+  const tag = `v${version}`;
+  if (capture(`git tag -l ${tag}`)) {
+    throw new Error(`Tag ${tag} already exists locally.`);
+  }
+
+  const proceed = await prompt(
+    `About to bump package.json to ${version}, commit, tag ${tag}, and push both to origin/main. Continue? [y/N] `,
+  );
+  if (!/^y(es)?$/i.test(proceed)) {
+    console.log('Aborted.');
+    return;
+  }
+
+  run(`pnpm pkg set version="${version}"`);
+  run('git add package.json');
+  run(`git commit -m "chore: release ${tag}"`);
+  run(`git tag ${tag}`);
+  run('git push origin main');
+  run(`git push origin ${tag}`);
+
+  console.log(`Pushed ${tag} — release workflow will build, publish, and update the changelog.`);
+}
+
+main().catch((err) => {
+  console.error(err.message ?? err);
+  process.exit(1);
+});