Merge pull request 'ci: build docker images only on release tags' (#9) from chore/release-on-tags into master
Reviewed-on: #9
This commit was merged in pull request #9.
This commit is contained in:
commit
28dfce246a
3 files changed
+41
-57
No files matched your search
+23
-41
@@ -1,9 +1,8 @@
|
|||||||
# Code quality checks on master and pull requests. The server and client jobs
|
# 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
|
# only run when their directory (or shared root files) changed. On a release
|
||||||
# master, also builds the Docker image and pushes it to this Gitea instance's
|
# tag push (vX.Y.Z), runs both jobs unconditionally and then builds the Docker
|
||||||
# container registry, tagged with the root package.json version and `latest`
|
# image and pushes it to this Gitea instance's container registry, tagged with
|
||||||
# - unless that version's image already exists in the registry, in which case
|
# the version and `latest`. The tag must match the root package.json version.
|
||||||
# the push is skipped.
|
|
||||||
#
|
#
|
||||||
# Needs a repository (or owner) secret REGISTRY_TOKEN: a Gitea access token
|
# Needs a repository (or owner) secret REGISTRY_TOKEN: a Gitea access token
|
||||||
# with package write access for the repository owner. The registry host is
|
# with package write access for the repository owner. The registry host is
|
||||||
@@ -15,13 +14,16 @@ name: CI
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [master]
|
branches: [master]
|
||||||
|
tags: ['v[0-9]+.[0-9]+.[0-9]+']
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
env:
|
env:
|
||||||
REGISTRY: git.hq.ars9.space
|
REGISTRY: git.hq.ars9.space
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
# Not needed on tag pushes: server and client always run there
|
||||||
changes:
|
changes:
|
||||||
|
if: ${{ !startsWith(github.ref, 'refs/tags/') }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
outputs:
|
outputs:
|
||||||
server: ${{ steps.filter.outputs.server }}
|
server: ${{ steps.filter.outputs.server }}
|
||||||
@@ -45,7 +47,10 @@ jobs:
|
|||||||
|
|
||||||
server:
|
server:
|
||||||
needs: changes
|
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
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -65,7 +70,10 @@ jobs:
|
|||||||
|
|
||||||
client:
|
client:
|
||||||
needs: changes
|
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
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -83,46 +91,20 @@ jobs:
|
|||||||
- name: Storybook tests
|
- name: Storybook tests
|
||||||
run: npm run -w client test:storybook
|
run: npm run -w client test:storybook
|
||||||
|
|
||||||
# Skips the image job if the registry already has this version's image
|
image:
|
||||||
version:
|
needs: [server, client]
|
||||||
if: github.event_name == 'push'
|
if: ${{ !failure() && !cancelled() && startsWith(github.ref, 'refs/tags/') }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
outputs:
|
|
||||||
version: ${{ steps.check.outputs.version }}
|
|
||||||
changed: ${{ steps.check.outputs.changed }}
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- id: check
|
- name: Check the tag matches package.json
|
||||||
env:
|
|
||||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
|
||||||
OWNER: ${{ github.repository_owner }}
|
|
||||||
run: |
|
run: |
|
||||||
version=$(node -p "require('./package.json').version")
|
version=$(node -p "require('./package.json').version")
|
||||||
image="${REGISTRY}/$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')"
|
if [ "${GITHUB_REF_NAME}" != "v${version}" ]; then
|
||||||
echo "$REGISTRY_TOKEN" | docker login "$REGISTRY" -u "$OWNER" --password-stdin
|
echo "tag ${GITHUB_REF_NAME} does not match package.json version ${version}"
|
||||||
if docker manifest inspect "${image}:${version}" >/dev/null 2>&1; then
|
exit 1
|
||||||
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"
|
|
||||||
fi
|
fi
|
||||||
echo "version=${version}" >> "$GITHUB_OUTPUT"
|
echo "VERSION=${version}" >> "$GITHUB_ENV"
|
||||||
|
|
||||||
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
|
|
||||||
- name: Log in to the registry
|
- name: Log in to the registry
|
||||||
env:
|
env:
|
||||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||||
|
|||||||
@@ -28,7 +28,9 @@ The live database is `data/liqa.db`. The container applies pending migrations be
|
|||||||
|
|
||||||
## Branching
|
## 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
|
## 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`).
|
- 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`, ...).
|
- 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).
|
When asked to release:
|
||||||
2. Run the code quality checks above.
|
|
||||||
|
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.
|
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 `## <version> - <YYYY-MM-DD>` entry at the top of `CHANGELOG.md` ("Changes since <previous version>:", then `### Added` / `### Changed` / `### Fixed`). Mark breaking changes with **Breaking:**.
|
4. Add a `## <version> - <YYYY-MM-DD>` entry at the top of `CHANGELOG.md` ("Changes since <previous version>:", 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).
|
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 <version>`), not in the subject line. This overrides the skill's rule of putting versions in the subject.
|
||||||
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 <version>`), not in the subject line. This overrides the skill's rule of putting versions in the subject. Then make the commit with that message.
|
6. **Tag the release commit** with an annotated tag `v<version>` whose message is that version's `CHANGELOG.md` entry, verbatim (from its `## <version>` 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:
|
||||||
7. **Tag the version commit** with an annotated tag `v<version>` whose message is that version's `CHANGELOG.md` entry, verbatim (from its `## <version>` 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:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
v=<version>
|
v=<version>
|
||||||
@@ -65,5 +68,5 @@ When asked to commit:
|
|||||||
| git tag -a "v$v" --cleanup=whitespace -F -
|
| 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.
|
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. **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.
|
8. **Ask the user whether to rebuild and restart the docker compose containers** (`docker compose up -d --build`); don't do it without confirmation.
|
||||||
+5
-6
@@ -245,13 +245,12 @@ Before adding a dependency, check its license is compatible with MIT distributio
|
|||||||
|
|
||||||
## CI (Gitea Actions)
|
## 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.
|
- **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): lint (no warnings allowed), type-check, tests, build.
|
- **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): lint (no warnings allowed), build, Storybook tests in headless Chromium.
|
- **client** (skipped if nothing under `client/` changed; always runs on tags): 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 `<registry>/<owner>/<repo>:<version>` image; skips the image job if that tag is already present.
|
- **image** (release tags only): after the server and client jobs pass, checks that the tag matches the root `package.json` version (`v<version>`), 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 `<registry>/<owner>/<repo>:<version>` and `:latest`. Merges to `master` don't build images.
|
||||||
- **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 `<registry>/<owner>/<repo>:<version>` and `:latest`.
|
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user