@regardio/dev 2.4.1 → 2.6.0

package/templates/actions/forgejo-release.yml

@@ -0,0 +1,116 @@
+# Regardio npm-publishing workflow — Forgejo Actions
+#
+# Pushes to staging and production are driven by ship tooling, not by hand:
+#   pnpm ship:staging    — fast-forward main → staging (no version bump)
+#   pnpm ship:production — version bump + main → production + sync staging
+#   pnpm ship:hotfix finish — version bump + hotfix → production → staging → main
+#
+# Full documentation: node_modules/@regardio/dev/docs/en/tools/releases.md
+#
+# This template covers the npm-publishing case.
+# Adapt the publish job for Docker / Coolify deployments as needed.
+#
+# Required setup:
+#   1. Ship scripts in package.json (ship:hotfix, ship:production, ship:staging)
+#   2. .versionrc.json in each publishable package directory
+#      (template: node_modules/@regardio/dev/templates/versionrc/.versionrc.json)
+#   3. staging and production branches created and pushed
+#   4. NPM_TOKEN repo secret; first publish of any new package done locally
+#
+# NOTE: npm provenance is not supported on Forgejo. If Forgejo is added to
+# npm's trusted-publisher list in the future, add --provenance to the publish step.
+
+name: Release
+
+on:
+  push:
+    branches: [staging, production]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref_name == 'staging' }}
+
+jobs:
+  typecheck:
+    name: ʦ TypeScript
+    # Husky enforces typecheck pre-commit; only re-run on production to guard against hotfixes.
+    if: github.ref_name == 'production'
+    runs-on: codeberg-small
+    timeout-minutes: 8
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+      - run: corepack enable
+      - name: Get pnpm store path
+        id: pnpm-store
+        run: echo "path=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.pnpm-store.outputs.path }}
+          key: pnpm-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
+          restore-keys: pnpm-${{ runner.os }}-
+      - run: pnpm install --frozen-lockfile --ignore-scripts --prefer-offline
+      - run: pnpm typecheck
+
+  test:
+    name: ⚫️ Test
+    runs-on: codeberg-small
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+      - run: corepack enable
+      - name: Get pnpm store path
+        id: pnpm-store
+        run: echo "path=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.pnpm-store.outputs.path }}
+          key: pnpm-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
+          restore-keys: pnpm-${{ runner.os }}-
+      - run: pnpm install --frozen-lockfile --ignore-scripts --prefer-offline
+      - run: pnpm test
+
+  publish:
+    name: 📦 Publish
+    needs: [typecheck, test]
+    if: |
+      always() &&
+      github.ref_name == 'production' &&
+      needs.typecheck.result == 'success' &&
+      needs.test.result == 'success'
+    runs-on: codeberg-small
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+      - run: corepack enable
+      - name: Get pnpm store path
+        id: pnpm-store
+        run: echo "path=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.pnpm-store.outputs.path }}
+          key: pnpm-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
+          restore-keys: pnpm-${{ runner.os }}-
+      - name: Configure npm auth
+        run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: pnpm install --frozen-lockfile --ignore-scripts --prefer-offline
+      - run: pnpm -r build
+      - run: pnpm -r publish --access public --no-git-checks
+        env:
+          NPM_CONFIG_USERCONFIG: /root/.npmrc

package/templates/actions/github-release.yml

@@ -0,0 +1,93 @@
+# Regardio npm-publishing workflow — GitHub Actions
+#
+# Pushes to staging and production are driven by ship tooling, not by hand:
+#   pnpm ship:staging    — fast-forward main → staging (no version bump)
+#   pnpm ship:production — version bump + main → production + sync staging
+#   pnpm ship:hotfix finish — version bump + hotfix → production → staging → main
+#
+# Full documentation: node_modules/@regardio/dev/docs/en/tools/releases.md
+#
+# This template covers the npm-publishing case.
+# Adapt the publish job for Docker / Cloudflare deployments as needed.
+#
+# Required setup:
+#   1. Ship scripts in package.json (ship:hotfix, ship:production, ship:staging)
+#   2. .versionrc.json in each publishable package directory
+#      (template: node_modules/@regardio/dev/templates/versionrc/.versionrc.json)
+#   3. staging and production branches created and pushed
+#   4. NPM_TOKEN repo secret; first publish of any new package done locally
+
+name: Release
+
+on:
+  push:
+    branches: [staging, production]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref_name == 'staging' }}
+
+jobs:
+  typecheck:
+    name: ʦ TypeScript
+    # Husky enforces typecheck pre-commit; only re-run on production to guard against hotfixes.
+    if: github.ref_name == 'production'
+    runs-on: ubuntu-latest
+    timeout-minutes: 8
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+      - uses: pnpm/action-setup@v5
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile --ignore-scripts --prefer-offline
+      - run: pnpm typecheck
+
+  test:
+    name: ⚫️ Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+      - uses: pnpm/action-setup@v5
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile --ignore-scripts --prefer-offline
+      - run: pnpm test
+
+  publish:
+    name: 📦 Publish
+    needs: [typecheck, test]
+    if: |
+      always() &&
+      github.ref_name == 'production' &&
+      needs.typecheck.result == 'success' &&
+      needs.test.result == 'success'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: pnpm/action-setup@v5
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: pnpm
+          registry-url: https://registry.npmjs.org
+      - run: pnpm install --frozen-lockfile --ignore-scripts --prefer-offline
+      - run: pnpm -r build
+      - run: pnpm -r publish --access public --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_CONFIG_PROVENANCE: "true"

package/templates/agents/CLAUDE.md

@@ -0,0 +1,37 @@
+# [Project Name] — Agent Context
+
+[One sentence: what this project is and its role.]
+
+## Standards
+
+This project uses `@regardio/dev`. After `pnpm install`, all Regardio standards are available locally:
+
+| What | Path |
+|------|------|
+| Full index | `node_modules/@regardio/dev/docs/en/README.md` |
+| Principles | `node_modules/@regardio/dev/docs/en/principles.md` |
+| Writing & language | `node_modules/@regardio/dev/docs/en/writing.md` |
+| Documentation shape | `node_modules/@regardio/dev/docs/en/documentation.md` |
+| Code standards | `node_modules/@regardio/dev/docs/en/standards/` |
+| Toolchain | `node_modules/@regardio/dev/docs/en/tools/` |
+
+Read the full index first. It lists every standard and toolchain doc in one place.
+
+## Structure
+
+[Describe the project's key directories and what lives where.]
+
+## Commands
+
+```bash
+pnpm build      # Build
+pnpm test       # Run tests
+pnpm typecheck  # Type check
+pnpm lint       # Lint
+```
+
+Run `typecheck` and `lint` before calling a task done.
+
+## Working here
+
+[Anything project-specific an agent needs to know: domain context, conventions that differ from the standards, areas to be careful about.]

package/templates/versionrc/.versionrc.json

@@ -1,16 +1,48 @@
 {
   "commitAll": false,
+  "gitRawCommitsOpts": {
+    "path": "."
+  },
+  "releaseCommitMessageFormat": "chore(release): @my-scope/my-pkg@v{{currentTag}}",
   "sign": false,
-  "tagPrefix": "v",
+  "tagPrefix": "@my-scope/my-pkg@v",
   "types": [
-    { "section": "Features", "type": "feat" },
-    { "section": "Bug Fixes", "type": "fix" },
-    { "section": "Performance", "type": "perf" },
-    { "section": "Refactoring", "type": "refactor" },
-    { "hidden": false, "section": "Chores", "type": "chore" },
-    { "hidden": true, "type": "docs" },
-    { "hidden": true, "type": "style" },
-    { "hidden": true, "type": "test" },
-    { "hidden": true, "type": "ci" }
+    {
+      "section": "Features",
+      "type": "feat"
+    },
+    {
+      "section": "Bug Fixes",
+      "type": "fix"
+    },
+    {
+      "section": "Performance",
+      "type": "perf"
+    },
+    {
+      "section": "Refactoring",
+      "type": "refactor"
+    },
+    {
+      "hidden": false,
+      "section": "Chores",
+      "type": "chore"
+    },
+    {
+      "hidden": true,
+      "type": "docs"
+    },
+    {
+      "hidden": true,
+      "type": "style"
+    },
+    {
+      "hidden": true,
+      "type": "test"
+    },
+    {
+      "hidden": true,
+      "type": "ci"
+    }
   ]
 }

package/templates/github/release.yml

@@ -1,68 +0,0 @@
-# Regardio Release Workflow (GitHub Actions)
-# Copy this file to .github/workflows/release.yml
-#
-# Required setup:
-# 1. Add these scripts to package.json:
-#      "release": "commit-and-tag-version",
-#      "release:major": "commit-and-tag-version --release-as major",
-#      "release:minor": "commit-and-tag-version --release-as minor",
-#      "release:patch": "commit-and-tag-version --release-as patch",
-#      "ship:staging": "ship-staging",
-#      "ship:production": "ship-production",
-#      "ship:hotfix": "ship-hotfix"
-# 2. Copy .versionrc.json from node_modules/@regardio/dev/templates/versionrc/.versionrc.json
-# 3. Create the branches:
-#      git checkout -b staging && git push -u origin staging
-#      git checkout -b production && git push -u origin production
-# 4. Add `NPM_TOKEN` to repo secrets. First npm publish of any new package
-#    must be done locally (`npm publish --access public`).
-#
-# Usage:
-# - `pnpm ship:staging` deploys to staging for validation (optional)
-# - `pnpm ship:production` runs commit-and-tag-version locally, bumps the version,
-#   merges to production. This workflow then publishes to npm.
-
-name: Release
-
-on:
-  push:
-    branches:
-      - production
-
-concurrency: ${{ github.workflow }}-${{ github.ref }}
-
-jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-        with:
-          fetch-depth: 0
-
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v5
-        with:
-          version: 10
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: 24
-          registry-url: https://registry.npmjs.org
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Build
-        run: pnpm -r build
-
-      - name: Publish changed public packages
-        run: pnpm -r publish --access public --no-git-checks
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NPM_CONFIG_PROVENANCE: "true"