add CI publishing

Author: zth

.github/workflows/publish.yml

@@ -0,0 +1,96 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "*"
+
+permissions:
+  contents: read
+  id-token: write
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js 24
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+
+      - name: Upgrade npm for trusted publishing
+        run: npm install --global npm@^11.5.1
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: 1.3.1
+
+      - name: Validate release tag
+        id: version
+        run: |
+          version="$(node -p "require('./package.json').version")"
+          tag="${GITHUB_REF_NAME}"
+
+          if [ "$tag" != "$version" ] && [ "$tag" != "v$version" ]; then
+            echo "Tag '$tag' does not match package.json version '$version'." >&2
+            exit 1
+          fi
+
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Determine npm dist-tag
+        id: dist_tag
+        run: |
+          node <<'NODE' >> "$GITHUB_OUTPUT"
+          const {version} = require("./package.json")
+          const prerelease = version.split("-")[1]
+          const distTag = prerelease ? prerelease.split(".")[0] : "latest"
+          console.log(`dist_tag=${distTag}`)
+          NODE
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build generated artifacts
+        run: |
+          bun run res:build
+          bun run build:resx-client
+
+      - name: Verify generated artifacts are committed
+        run: git diff --exit-code
+
+      - name: Run tests
+        run: bun run test
+
+      - name: Check whether this version is already published
+        id: already_published
+        run: |
+          if npm view "rescript-x@${{ steps.version.outputs.version }}" version >/dev/null 2>&1; then
+            echo "published=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "published=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Show packed contents
+        if: steps.already_published.outputs.published != 'true'
+        run: npm pack --dry-run
+
+      - name: Publish to npm
+        if: steps.already_published.outputs.published != 'true'
+        run: npm publish --tag "${{ steps.dist_tag.outputs.dist_tag }}"
+
+      - name: Skip duplicate publish
+        if: steps.already_published.outputs.published == 'true'
+        run: echo "rescript-x@${{ steps.version.outputs.version }} is already published, skipping."

README.md

@@ -40,6 +40,27 @@ In the demo:
 
 The Docker path is the safest default because it builds the Linux executable in-container and packages the executable together with the required `dist/` assets.
 
+## Publishing
+
+Publishing to npm is handled by GitHub Actions trusted publishing in `.github/workflows/publish.yml`.
+
+One-time npm setup:
+
+1. Open the `rescript-x` package settings on npm.
+2. Add a trusted publisher for GitHub Actions:
+   - owner: `zth`
+   - repository: `res-x`
+   - workflow file: `publish.yml`
+3. Save the trusted publisher.
+
+Release flow:
+
+1. Bump `package.json` to the version you want to publish.
+2. Commit the version bump and any generated artifact updates.
+3. Push a matching git tag. Both `1.2.2` and `v1.2.2` are accepted.
+
+The publish workflow rebuilds the package, regenerates `client/ResXClient.js`, runs the test suite, verifies that the build does not change tracked files, and then publishes to npm via OIDC. Pre-release versions publish under their pre-release identifier as the npm dist-tag, so `1.2.2-beta.1` publishes with the `beta` tag and `1.2.2-dev.1` publishes with the `dev` tag.
+
 ## Getting started
 
 First, make sure you have [`Bun`](https://bun.sh) installed and setup. Then, install `rescript-x` and the dependencies needed:

package.json

@@ -1,6 +1,18 @@
 {
   "name": "rescript-x",
+  "description": "A ReScript framework for building server-driven websites and applications on Bun and Vite.",
   "version": "1.2.1-dev.9",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zth/res-x.git"
+  },
+  "homepage": "https://github.com/zth/res-x#readme",
+  "bugs": {
+    "url": "https://github.com/zth/res-x/issues"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "scripts": {
     "build:resx-client": "node scripts/build-resx-client.mjs",
     "res:build": "rescript",