From a0624789cef6b12cd5603d2eb5b52d78ad6c0ebb Mon Sep 17 00:00:00 2001 From: Andrii Arsenin Date: Fri, 2 Oct 2026 14:36:59 +0300 Subject: [PATCH] ci: build docker images only on release tags - trigger the image job on vX.Y.Z tag pushes instead of master pushes - run server and client checks unconditionally on tags before the build - fail the build when the tag doesn't match the package.json version - document the release routine: version bump, changelog and tag are done on master after work branches are merged --- .gitea/workflows/ci.yml | 64 +++++++++++++++-------------------------- CLAUDE.md | 23 ++++++++------- docs/development.md | 11 ++++--- 3 files changed, 41 insertions(+), 57 deletions(-) diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml index 874e1cd..f0233e4 100644 --- a/.gitea/workflows/ci.yml +++ b/.gitea/workflows/ci.yml @@ -1,9 +1,8 @@ # Code quality checks on master and pull requests. The server and client jobs -# only run when their directory (or shared root files) changed. On a push to -# master, also builds the Docker image and pushes it to this Gitea instance's -# container registry, tagged with the root package.json version and `latest` -# - unless that version's image already exists in the registry, in which case -# the push is skipped. +# only run when their directory (or shared root files) changed. On a release +# tag push (vX.Y.Z), runs both jobs unconditionally and then builds the Docker +# image and pushes it to this Gitea instance's container registry, tagged with +# the version and `latest`. The tag must match the root package.json version. # # Needs a repository (or owner) secret REGISTRY_TOKEN: a Gitea access token # with package write access for the repository owner. The registry host is @@ -15,13 +14,16 @@ name: CI on: push: branches: [master] + tags: ['v[0-9]+.[0-9]+.[0-9]+'] pull_request: env: REGISTRY: git.hq.ars9.space jobs: + # Not needed on tag pushes: server and client always run there changes: + if: ${{ !startsWith(github.ref, 'refs/tags/') }} runs-on: ubuntu-latest outputs: server: ${{ steps.filter.outputs.server }} @@ -45,7 +47,10 @@ jobs: server: needs: changes - if: needs.changes.outputs.server == 'true' + # changes is skipped on tag pushes, hence !cancelled() + if: | + !cancelled() && + (startsWith(github.ref, 'refs/tags/') || needs.changes.outputs.server == 'true') runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -65,7 +70,10 @@ jobs: client: needs: changes - if: needs.changes.outputs.client == 'true' + # changes is skipped on tag pushes, hence !cancelled() + if: | + !cancelled() && + (startsWith(github.ref, 'refs/tags/') || needs.changes.outputs.client == 'true') runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -83,46 +91,20 @@ jobs: - name: Storybook tests run: npm run -w client test:storybook - # Skips the image job if the registry already has this version's image - version: - if: github.event_name == 'push' + image: + needs: [server, client] + if: ${{ !failure() && !cancelled() && startsWith(github.ref, 'refs/tags/') }} runs-on: ubuntu-latest - outputs: - version: ${{ steps.check.outputs.version }} - changed: ${{ steps.check.outputs.changed }} steps: - uses: actions/checkout@v4 - - id: check - env: - REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} - OWNER: ${{ github.repository_owner }} + - name: Check the tag matches package.json run: | version=$(node -p "require('./package.json').version") - image="${REGISTRY}/$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')" - echo "$REGISTRY_TOKEN" | docker login "$REGISTRY" -u "$OWNER" --password-stdin - if docker manifest inspect "${image}:${version}" >/dev/null 2>&1; then - echo "version ${version}: image already in registry, skipping" - echo "changed=false" >> "$GITHUB_OUTPUT" - else - echo "version ${version}: not in registry, building" - echo "changed=true" >> "$GITHUB_OUTPUT" + if [ "${GITHUB_REF_NAME}" != "v${version}" ]; then + echo "tag ${GITHUB_REF_NAME} does not match package.json version ${version}" + exit 1 fi - echo "version=${version}" >> "$GITHUB_OUTPUT" - - image: - needs: [server, client, version] - # server/client may be skipped when their paths didn't change - if: | - !failure() && !cancelled() && - github.event_name == 'push' && - needs.version.outputs.changed == 'true' && - (needs.server.result == 'success' || needs.server.result == 'skipped') && - (needs.client.result == 'success' || needs.client.result == 'skipped') - runs-on: ubuntu-latest - env: - VERSION: ${{ needs.version.outputs.version }} - steps: - - uses: actions/checkout@v4 + echo "VERSION=${version}" >> "$GITHUB_ENV" - name: Log in to the registry env: REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} diff --git a/CLAUDE.md b/CLAUDE.md index 72e4131..fee0913 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -28,7 +28,9 @@ The live database is `data/liqa.db`. The container applies pending migrations be ## Branching -Never commit directly to `master` when implementing a feature, chore or bug fix: create a separate branch for the work first. Only version-bump release commits (see "Committing a new version") are made on `master`. +Never commit directly to `master` when implementing a feature, chore or bug fix: create a separate branch for the work first, forked from `master`. These commits don't change the version or `CHANGELOG.md`; the branch is merged back to `master` through a pull request. Only release commits (see "Releasing a new version") are made on `master`. + +When committing on a work branch, also update the docs affected by the change (`docs/*.md`, `README.md`, `.env.example`, MCP tool descriptions) in the same branch. ## Code quality @@ -47,17 +49,18 @@ cd client && npm run lint && npm run build && npm run test:storybook - Server tests use an in-memory DB, a Playwright mock (`server/test/__mocks__/playwright.ts`), and a temporary files directory per test app (see `server/test/app.harness.ts`). - Import Node.js built-in modules with the `node:` prefix (`node:fs`, `node:path`, `node:crypto`, ...). -## Committing a new version +## Releasing a new version -When asked to commit: +A release is cut on `master` after one or more work branches have been merged (their pull request checks are already green). CI builds and pushes the Docker image only when a `vX.Y.Z` tag is pushed, not on merges. -1. **Ask which version to bump** - major, minor or patch - and propose a sensible default based on the changes: patch for fixes and small behavior/default tweaks, minor for new features, major for breaking changes (e.g. changed API or export/import formats that old clients or files can't use). -2. Run the code quality checks above. +When asked to release: + +1. Make sure you're on an up-to-date, clean `master` (`git switch master && git pull`), and collect the changes since the last release: `git log --oneline "$(git describe --tags --abbrev=0)"..HEAD`. +2. **Ask which version to bump** - major, minor or patch - and propose a sensible default based on those changes: patch for fixes and small behavior/default tweaks, minor for new features, major for breaking changes (e.g. changed API or export/import formats that old clients or files can't use). 3. Bump `version` in the root `package.json` and in both places at the top of `package-lock.json` (the root entry and `packages[""]`). `server/package.json` and `client/package.json` keep their own versions; don't bump them. 4. Add a `## - ` entry at the top of `CHANGELOG.md` ("Changes since :", then `### Added` / `### Changed` / `### Fixed`). Mark breaking changes with **Breaking:**. -5. Update the docs affected by the change (`docs/*.md`, `README.md`, `.env.example`, MCP tool descriptions). -6. Build the commit message with the `/git-commit` skill if it is available, following its format and rules. Otherwise use a conventional commit message (`type(scope): subject`, then a bullet list body). Either way, put the version bump in the body as a bullet (e.g. `- bump version to `), not in the subject line. This overrides the skill's rule of putting versions in the subject. Then make the commit with that message. -7. **Tag the version commit** with an annotated tag `v` whose message is that version's `CHANGELOG.md` entry, verbatim (from its `## ` heading up to the next version's heading). Commits without a version bump get no tag. `--cleanup=whitespace` is required: the default cleanup strips lines starting with `#`, which would drop the entry's headings: +5. Commit only these release changes on `master`. Build the commit message with the `/git-commit` skill if it is available, following its format and rules. Otherwise use a conventional commit message (`type(scope): subject`, then a bullet list body). Either way, put the version bump in the body as a bullet (e.g. `- bump version to `), not in the subject line. This overrides the skill's rule of putting versions in the subject. +6. **Tag the release commit** with an annotated tag `v` whose message is that version's `CHANGELOG.md` entry, verbatim (from its `## ` heading up to the next version's heading). `--cleanup=whitespace` is required: the default cleanup strips lines starting with `#`, which would drop the entry's headings: ```bash v= @@ -65,5 +68,5 @@ When asked to commit: | git tag -a "v$v" --cleanup=whitespace -F - ``` - Don't push the tag; tell the user to push with `git push --follow-tags`, which also pushes annotated tags. -8. **After committing, ask the user whether to rebuild and restart the docker compose containers** (`docker compose up -d --build`); don't do it without confirmation. +7. **Ask the user before pushing**, then push the commit and the tag together with `git push --follow-tags` (it also pushes annotated tags). The tag push triggers the image build; it fails if the tag doesn't match the `package.json` version. +8. **Ask the user whether to rebuild and restart the docker compose containers** (`docker compose up -d --build`); don't do it without confirmation. diff --git a/docs/development.md b/docs/development.md index 82ba9f6..f74c170 100644 --- a/docs/development.md +++ b/docs/development.md @@ -245,13 +245,12 @@ Before adding a dependency, check its license is compatible with MIT distributio ## CI (Gitea Actions) -`.gitea/workflows/ci.yml` runs on pushes to `master` and on pull requests: +`.gitea/workflows/ci.yml` runs on pushes to `master`, on pull requests and on release tags (`vX.Y.Z`): -- **changes**: detects which of `server/` and `client/` changed (via `dorny/paths-filter`), also treating root `package.json`/`package-lock.json` and the workflow file itself as affecting both. -- **server** (skipped if nothing under `server/` changed): lint (no warnings allowed), type-check, tests, build. -- **client** (skipped if nothing under `client/` changed): lint (no warnings allowed), build, Storybook tests in headless Chromium. -- **version** (pushes to `master` only): reads `version` from the root `package.json` and checks the registry for an existing `//:` image; skips the image job if that tag is already present. -- **image** (pushes to `master` only): when the version job found no existing image for the current version, and the server/client jobs passed or were skipped, builds the Docker image and pushes it to the Gitea container registry set by `REGISTRY` at the top of the workflow (`git.hq.ars9.space`) as `//:` and `:latest`. +- **changes** (not on tags): detects which of `server/` and `client/` changed (via `dorny/paths-filter`), also treating root `package.json`/`package-lock.json` and the workflow file itself as affecting both. +- **server** (skipped if nothing under `server/` changed; always runs on tags): lint (no warnings allowed), type-check, tests, build. +- **client** (skipped if nothing under `client/` changed; always runs on tags): lint (no warnings allowed), build, Storybook tests in headless Chromium. +- **image** (release tags only): after the server and client jobs pass, checks that the tag matches the root `package.json` version (`v`), builds the Docker image and pushes it to the Gitea container registry set by `REGISTRY` at the top of the workflow (`git.hq.ars9.space`) as `//:` and `:latest`. Merges to `master` don't build images. The image job logs in as the repository owner with the `REGISTRY_TOKEN` secret: a Gitea access token with package write access (Settings → Applications → token with `write:package`), added under the repository's Settings → Actions → Secrets. It runs `docker` on the runner, so the runner must give jobs access to a Docker daemon (act_runner mounts the host's Docker socket into job containers by default). -- 2.54.0