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
This commit is contained in:
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
|
||||
# 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 }}
|
||||
|
||||
Reference in new issue
Block a user