Add release pipeline and upgrade toolchain to TypeScript 7
Publish snapshot / snapshot (push) Failing after 1m58s

Publishing infrastructure
- Three Gitea workflows: ci.yml (PRs, non-main pushes), publish-snapshot.yml
  (main -> Gitea under dist-tag @main) and release.yml (tags -> Gitea + npmjs)
- Tag-driven releases as <package-dir>-v<version>; the manifest stays the
  source of truth and release.yml refuses to run if tag and manifest disagree
- Every publish is idempotent: each step checks the registry first, so a run
  that fails on the second registry can simply be re-run
- Hard coverage gate (85% branches) shared by CI, the pre-push hook and local
  runs, since the thresholds live in vitest.config.ts rather than a CI flag
- README.PUBLISH.md documents the whole mechanism

Toolchain
- TypeScript 7 native compiler; drop tsgo and ts-node, use tsx for dev runs
- Biome 1.9 -> 2.x, Vitest 1 -> 4, zod 3 -> 4, inquirer 8 -> 14, pnpm 11.17.0
- Replace inquirer-checkbox-plus-prompt, which is peer-capped at inquirer <9,
  with enquirer's AutoComplete; the CubeSelection contract is unchanged
- Stand in for zod 4's removed z.AnyZodObject with a local AnyObjectSchema

Repo hygiene
- Stop tracking dist/; ignore coverage/, *.tsbuildinfo, .npmrc* and release.json
- Drop package-lock.json in favour of pnpm-lock.yaml

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Benjamin Diedrichsen
2026-07-27 15:17:14 +02:00
parent 736c01216a
commit 587ff2cf47
126 changed files with 6065 additions and 7544 deletions
+91
View File
@@ -0,0 +1,91 @@
# Verification gate for everything that is not a `main` push.
#
# `main` is covered by publish-snapshot.yml, which runs the identical gate
# before it publishes — running both here would just duplicate the work.
name: CI
on:
pull_request:
push:
branches-ignore:
- main
tags-ignore:
- '**'
concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true
jobs:
verify:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v4
- name: Set up pnpm
# Version comes from `packageManager` in the root package.json.
uses: pnpm/action-setup@v4
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
- name: Locate the pnpm store
id: pnpm-store
run: echo "path=$(pnpm store path --silent)" >> "$GITHUB_OUTPUT"
- name: Restore the pnpm store
# A runner without a cache server should be slow, not broken.
continue-on-error: true
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: Install
run: pnpm install --frozen-lockfile
- name: Lint
run: pnpm run lint:ci
- name: Typecheck
run: pnpm run typecheck
- name: Test with coverage
# Fails the job below 85% branch coverage — see the `thresholds` block
# in each package's vitest.config.ts.
run: pnpm run test:coverage
- name: Summarise coverage
# Reporting only — the gate is the step above.
if: always()
continue-on-error: true
run: pnpm run coverage:summary
- name: Build
run: pnpm run build
- name: Check the published file lists
# Scripts are off because the build already ran; `prepack` would only
# repeat it. Catches a `files`/`bin` entry that no longer exists.
run: |
set -euo pipefail
for pkg in packages/*/; do
echo "::group::npm pack $pkg"
(cd "$pkg" && npm pack --dry-run --ignore-scripts)
echo "::endgroup::"
done
- name: Upload coverage reports
if: always()
continue-on-error: true
uses: actions/upload-artifact@v3
with:
name: coverage
path: packages/*/coverage
retention-days: 7
+124
View File
@@ -0,0 +1,124 @@
# Every commit that lands on `main` publishes a prerelease of both packages to
# the Gitea npm registry under the `main` dist-tag:
#
# pnpm add @bitstack/nopy@main
#
# The verification gate runs here rather than in ci.yml so a snapshot can never
# be published from a red `main`. Versions are derived, never committed —
# releases to npmjs are cut by hand via a tag (see release.yml).
name: Publish snapshot
on:
push:
branches:
- main
concurrency:
group: snapshot-${{ github.ref }}
cancel-in-progress: false
jobs:
snapshot:
runs-on: ubuntu-latest
env:
# e.g. https://gitea.example.com/api/packages/BitSquare/npm/
REGISTRY: ${{ github.server_url }}/api/packages/${{ github.repository_owner }}/npm/
# GITEA_TOKEN is injected automatically; override with a PAT that carries
# `write:package` if the automatic token is not scoped for the registry.
REGISTRY_TOKEN: ${{ secrets.GITEA_NPM_TOKEN || secrets.GITEA_TOKEN }}
NPMRC: ${{ github.workspace }}/.npmrc-gitea
steps:
- name: Check out
uses: actions/checkout@v4
- name: Set up pnpm
# Version comes from `packageManager` in the root package.json.
uses: pnpm/action-setup@v4
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
- name: Locate the pnpm store
id: pnpm-store
run: echo "path=$(pnpm store path --silent)" >> "$GITHUB_OUTPUT"
- name: Restore the pnpm store
continue-on-error: true
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: Install
run: pnpm install --frozen-lockfile
- name: Lint
run: pnpm run lint:ci
- name: Typecheck
run: pnpm run typecheck
- name: Test with coverage
run: pnpm run test:coverage
- name: Summarise coverage
# Reporting only — the gate is the step above.
if: always()
continue-on-error: true
run: pnpm run coverage:summary
- name: Build
# Explicit, so the publish step can skip lifecycle scripts entirely.
run: pnpm run build
- name: Authenticate against the Gitea registry
run: |
set -euo pipefail
if [ -z "${REGISTRY_TOKEN}" ]; then
echo "::error::No registry token. Add a GITEA_NPM_TOKEN secret with write:package scope."
exit 1
fi
install -m 600 /dev/null "$NPMRC"
{
printf '@bitstack:registry=%s\n' "$REGISTRY"
printf '//%s:_authToken=%s\n' "${REGISTRY#*://}" "$REGISTRY_TOKEN"
} >> "$NPMRC"
- name: Publish snapshots
run: |
set -euo pipefail
export npm_config_userconfig="$NPMRC"
: "${GITHUB_STEP_SUMMARY:=/dev/null}"
short_sha=$(git rev-parse --short=7 HEAD)
for dir in packages/*/; do
name=$(node -p "require('./${dir}package.json').name")
base=$(node -p "require('./${dir}package.json').version")
# `g` prefix keeps the identifier a valid semver one even when the
# abbreviated sha happens to be all digits.
version="${base}-main.${{ github.run_number }}.g${short_sha}"
echo "::group::${name}@${version}"
if npm view "${name}@${version}" version --registry "$REGISTRY" >/dev/null 2>&1; then
echo "Already published — skipping (this is a re-run of the same workflow)."
else
(
cd "$dir"
npm pkg set "version=${version}"
npm publish --ignore-scripts --tag main --registry "$REGISTRY"
)
fi
echo "::endgroup::"
echo "- \`pnpm add ${name}@${version}\`" >> "$GITHUB_STEP_SUMMARY"
done
- name: Remove the registry credentials
if: always()
run: rm -f "$NPMRC"
+243
View File
@@ -0,0 +1,243 @@
# Tag-driven release of a single package.
#
# git tag nopy-v1.2.0 && git push origin nopy-v1.2.0
# git tag keyman-v1.2.0 && git push origin keyman-v1.2.0
#
# The tag is the source of truth for *which* package ships; package.json is the
# source of truth for the version, and the two must agree or the run fails.
# A version with a prerelease part (1.2.0-rc.1) publishes under `next` instead
# of `latest`.
#
# Required secrets:
# NPM_TOKEN npmjs automation token with publish rights on @bitstack
# GITEA_NPM_TOKEN optional; PAT with write:package if GITEA_TOKEN is not enough
name: Release
on:
push:
tags:
- '*-v*'
concurrency:
group: release-${{ github.ref }}
cancel-in-progress: false
jobs:
release:
runs-on: ubuntu-latest
env:
GITEA_REGISTRY: ${{ github.server_url }}/api/packages/${{ github.repository_owner }}/npm/
GITEA_REGISTRY_TOKEN: ${{ secrets.GITEA_NPM_TOKEN || secrets.GITEA_TOKEN }}
NPMJS_REGISTRY: https://registry.npmjs.org/
NPMJS_TOKEN: ${{ secrets.NPM_TOKEN }}
NPMRC: ${{ github.workspace }}/.npmrc-release
steps:
- name: Check out
uses: actions/checkout@v4
- name: Resolve the release from the tag
id: target
run: |
set -euo pipefail
tag="${GITHUB_REF#refs/tags/}"
pkg="${tag%-v*}"
version="${tag##*-v}"
dir="packages/${pkg}"
if [ ! -f "${dir}/package.json" ]; then
echo "::error::Tag '${tag}' names package '${pkg}', but ${dir}/package.json does not exist."
exit 1
fi
declared=$(node -p "require('./${dir}/package.json').version")
if [ "$declared" != "$version" ]; then
echo "::error::Tag '${tag}' asks for ${version}, but ${dir}/package.json declares ${declared}. Bump the manifest and re-tag."
exit 1
fi
name=$(node -p "require('./${dir}/package.json').name")
case "$version" in
*-*) dist_tag=next ;;
*) dist_tag=latest ;;
esac
{
echo "tag=${tag}"
echo "dir=${dir}"
echo "name=${name}"
echo "version=${version}"
echo "dist_tag=${dist_tag}"
} >> "$GITHUB_OUTPUT"
echo "Releasing ${name}@${version} from ${dir} as '${dist_tag}'."
- name: Check the required secrets are present
run: |
set -euo pipefail
missing=0
[ -n "${NPMJS_TOKEN}" ] || { echo "::error::NPM_TOKEN secret is not set."; missing=1; }
[ -n "${GITEA_REGISTRY_TOKEN}" ] || { echo "::error::No Gitea registry token available."; missing=1; }
exit "$missing"
- name: Set up pnpm
# Version comes from `packageManager` in the root package.json.
uses: pnpm/action-setup@v4
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
- name: Locate the pnpm store
id: pnpm-store
run: echo "path=$(pnpm store path --silent)" >> "$GITHUB_OUTPUT"
- name: Restore the pnpm store
continue-on-error: true
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: Install
run: pnpm install --frozen-lockfile
- name: Lint
run: pnpm run lint:ci
- name: Typecheck
run: pnpm run typecheck
- name: Test with coverage
run: pnpm run test:coverage
- name: Build
# Explicit, so the publish steps can skip lifecycle scripts entirely.
run: pnpm run build
- name: Publish to the Gitea registry
env:
NAME: ${{ steps.target.outputs.name }}
VERSION: ${{ steps.target.outputs.version }}
DIST_TAG: ${{ steps.target.outputs.dist_tag }}
DIR: ${{ steps.target.outputs.dir }}
run: |
set -euo pipefail
install -m 600 /dev/null "$NPMRC"
{
printf '@bitstack:registry=%s\n' "$GITEA_REGISTRY"
printf '//%s:_authToken=%s\n' "${GITEA_REGISTRY#*://}" "$GITEA_REGISTRY_TOKEN"
} >> "$NPMRC"
export npm_config_userconfig="$NPMRC"
if npm view "${NAME}@${VERSION}" version --registry "$GITEA_REGISTRY" >/dev/null 2>&1; then
echo "${NAME}@${VERSION} is already on Gitea — skipping."
else
(cd "$DIR" && npm publish --ignore-scripts --tag "$DIST_TAG" --registry "$GITEA_REGISTRY")
fi
- name: Publish to npmjs
env:
NAME: ${{ steps.target.outputs.name }}
VERSION: ${{ steps.target.outputs.version }}
DIST_TAG: ${{ steps.target.outputs.dist_tag }}
DIR: ${{ steps.target.outputs.dir }}
run: |
set -euo pipefail
install -m 600 /dev/null "$NPMRC"
{
printf '@bitstack:registry=%s\n' "$NPMJS_REGISTRY"
printf '//%s:_authToken=%s\n' "${NPMJS_REGISTRY#*://}" "$NPMJS_TOKEN"
} >> "$NPMRC"
export npm_config_userconfig="$NPMRC"
if npm view "${NAME}@${VERSION}" version --registry "$NPMJS_REGISTRY" >/dev/null 2>&1; then
echo "${NAME}@${VERSION} is already on npmjs — skipping."
else
# No --provenance: that needs GitHub Actions OIDC, which Gitea has no
# equivalent for.
(cd "$DIR" && npm publish --ignore-scripts --tag "$DIST_TAG" --access public --registry "$NPMJS_REGISTRY")
fi
- name: Remove the registry credentials
if: always()
run: rm -f "$NPMRC"
- name: Create the Gitea release
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
TAG: ${{ steps.target.outputs.tag }}
NAME: ${{ steps.target.outputs.name }}
VERSION: ${{ steps.target.outputs.version }}
DIST_TAG: ${{ steps.target.outputs.dist_tag }}
DIR: ${{ steps.target.outputs.dir }}
run: |
set -euo pipefail
api="${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}/releases"
status=$(curl -sS -o /dev/null -w '%{http_code}' \
-H "Authorization: token ${GITEA_TOKEN}" "${api}/tags/${TAG}")
if [ "$status" = "200" ]; then
echo "A release for ${TAG} already exists — leaving it alone."
exit 0
fi
# The section of the hand-written changelog that names this version.
notes=""
if [ -f "${DIR}/CHANGELOG.md" ]; then
notes=$(awk -v v="$VERSION" '
/^## / { if (found) exit; if (index($0, v)) { found = 1; next } }
found { print }
' "${DIR}/CHANGELOG.md")
fi
export NOTES="$notes"
node -e '
const { NAME, VERSION, TAG, DIST_TAG, NOTES } = process.env;
const install =
DIST_TAG === "latest"
? `npm install -g ${NAME}`
: `npm install -g ${NAME}@${VERSION}`;
const body = [
NOTES.trim(),
"",
"```sh",
install,
"```",
].join("\n").trim();
console.log(JSON.stringify({
tag_name: TAG,
name: `${NAME} v${VERSION}`,
body,
draft: false,
prerelease: DIST_TAG !== "latest",
}));
' > release.json
curl -sS -f -X POST \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
--data-binary @release.json \
"$api"
rm -f release.json
- name: Summarise
# Reporting only; never the reason a green release goes red.
continue-on-error: true
env:
NAME: ${{ steps.target.outputs.name }}
VERSION: ${{ steps.target.outputs.version }}
DIST_TAG: ${{ steps.target.outputs.dist_tag }}
run: |
set -euo pipefail
: "${GITHUB_STEP_SUMMARY:=/dev/null}"
{
echo "### Released \`${NAME}@${VERSION}\` (\`${DIST_TAG}\`)"
echo ""
echo "- npmjs: \`npm install -g ${NAME}@${VERSION}\`"
echo "- Gitea: \`npm install -g ${NAME}@${VERSION} --registry ${GITEA_REGISTRY}\`"
} >> "$GITHUB_STEP_SUMMARY"