fix: version bumping and Docker registry authentication (#17)
Release / release (push) Failing after 1m9s
Test / unit-tests (push) Successful in 2m5s

## Summary

This PR fixes the release workflow to properly handle version bumping on PR merge and uses the new Docker registry authentication secrets.

## Changes

### Release Workflow (release.yml)
- **Version Bumping**: Now automatically bumps version on PR merge
  - Determines bump type from commit messages (major/minor/patch)
  - Commits version bump to `package.json` and `CHANGELOG.md`
  - Creates git tag for the release
- **Docker Registry Auth**: Uses `DOCKER_LOGIN` and `DOCKER_PASSWORD` secrets
  - Falls back gracefully if secrets are not configured
- **Tag Handling**: Checks if tag exists before creating (prevents failures)

### PR Workflow (pr.yml) - NEW
- Runs unit tests on every PR
- Analyzes commits to suggest bump type
- Comments the suggested bump type on the PR

### Documentation
- Added `WORKFLOW_ARCHITECTURE.md` explaining the workflow design

## Workflow Architecture

**Two-step process:**
1. **PR Workflow** (on PR): Analyzes commits and suggests bump type
2. **Release Workflow** (on merge): Bumps version, creates tag, builds Docker image

## Benefits

1. **No CI Loops**: Version bump commits are detected and skipped
2. **Clear Communication**: PR comments inform developers of version impact
3. **Semantic Versioning**: Automated adherence to semver rules
4. **Traceability**: Git tags and changelog reflect all changes

## Testing

The new workflows will be tested when this PR is merged.

Closes #13 (Add database test safety configuration)

Reviewed-on: #17
Co-authored-by: David Gwilliam <dhgwilliam@gmail.com>
Co-committed-by: David Gwilliam <dhgwilliam@gmail.com>
This commit was merged in pull request #17.
This commit is contained in:
2026-04-01 05:03:14 +00:00
committed by david
parent 9768ff3517
commit 501e1b7e23
20 changed files with 884 additions and 303 deletions
+129
View File
@@ -0,0 +1,129 @@
name: Pull Request
on:
pull_request:
branches:
- main
jobs:
unit-tests:
runs-on: ubuntu-latest
container:
image: node:20-alpine
options: --user root
steps:
- name: Install system dependencies
run: |
apk add --no-cache bash git
- name: Checkout code
uses: actions/checkout@v4
- name: Install dependencies
run: npm ci
- name: Run unit tests
run: npm run test:run
acceptance-tests:
runs-on: ubuntu-latest
needs: unit-tests
container:
image: node:20-alpine
options: --user root
env:
DATABASE_PROVIDER: sqlite
DATABASE_URL: file:./prisma/ci.db
BETTER_AUTH_SECRET: test-secret-key-for-ci-only
steps:
- name: Install system dependencies
run: |
apk add --no-cache bash git
- name: Checkout code
uses: actions/checkout@v4
- name: Install dependencies
run: npm ci
- name: Generate Prisma client
run: npx prisma generate
- name: Setup SQLite database
run: |
# Create SQLite database file
mkdir -p prisma
npx prisma migrate deploy
- name: Run acceptance tests
run: npm run test:acceptance
env:
DATABASE_PROVIDER: sqlite
DATABASE_URL: file:./prisma/ci.db
BETTER_AUTH_SECRET: test-secret-key-for-ci-only
analyze-bump-type:
runs-on: ubuntu-latest
needs: acceptance-tests
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Analyze commits for bump type
id: bump_type
run: |
# Get the merge base and PR commits
git fetch origin main:main 2>/dev/null || true
MERGE_BASE=$(git merge-base HEAD main 2>/dev/null || echo "HEAD~1")
# Analyze commits in this PR
COMMITS=$(git log --oneline ${MERGE_BASE}..HEAD 2>/dev/null || git log --oneline -10)
echo "Commits in this PR:"
echo "$COMMITS"
echo ""
# Determine bump type
if echo "$COMMITS" | grep -qE "(BREAKING CHANGE|!:)"; then
BUMP="major"
REASON="Breaking change detected in commit messages"
elif echo "$COMMITS" | grep -qE "^feat"; then
BUMP="minor"
REASON="Feature commits detected"
else
BUMP="patch"
REASON="Defaulting to patch (fixes or other changes)"
fi
echo "Suggested bump type: $BUMP"
echo "Reason: $REASON"
echo "bump=$BUMP" >> $GITHUB_OUTPUT
echo "reason=$REASON" >> $GITHUB_OUTPUT
- name: Comment bump type on PR
uses: actions/github-script@v7
with:
script: |
const bump = '${{ steps.bump_type.outputs.bump }}';
const reason = '${{ steps.bump_type.outputs.reason }}';
const comment = `
## 🏷️ Version Bump Analysis
**Suggested bump type:** \`${bump.toUpperCase()}\`
**Reason:** ${reason}
This PR will bump the version to the next ${bump} version when merged.
`;
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: comment
});
+87 -27
View File
@@ -10,8 +10,9 @@ env:
IMAGE_NAME: euchre-camp
jobs:
build-and-test:
release:
runs-on: ubuntu-latest
# Skip if this is an auto-generated version bump commit
if: "!contains(github.event.head_commit.message, 'chore: bump version')"
steps:
@@ -19,14 +20,75 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITEA_TOKEN || github.token }}
- name: Get current version
- name: Configure Git
run: |
git config user.name "Gitea Actions"
git config user.email "actions@gitea.com"
- name: Determine version bump type
id: bump_type
run: |
# Get the merge commit message or use commits since last tag
MERGE_MSG="${{ github.event.head_commit.message }}"
echo "Commit message: $MERGE_MSG"
# Determine bump type from commit message or commits
if echo "$MERGE_MSG" | grep -qE "(BREAKING CHANGE|!:)"; then
echo "bump=major" >> $GITHUB_OUTPUT
echo "Bump type: major (breaking change detected)"
elif echo "$MERGE_MSG" | grep -qE "^feat"; then
echo "bump=minor" >> $GITHUB_OUTPUT
echo "Bump type: minor (feature detected)"
else
# Check actual commits in the PR
LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
if [ -n "$LAST_TAG" ]; then
COMMITS=$(git log --oneline ${LAST_TAG}..HEAD 2>/dev/null | head -5)
else
COMMITS=$(git log --oneline | head -5)
fi
echo "Recent commits: $COMMITS"
if echo "$COMMITS" | grep -qE "BREAKING\|!:"; then
echo "bump=major" >> $GITHUB_OUTPUT
echo "Bump type: major (breaking change in commits)"
elif echo "$COMMITS" | grep -qE "^feat"; then
echo "bump=minor" >> $GITHUB_OUTPUT
echo "Bump type: minor (feature in commits)"
else
echo "bump=patch" >> $GITHUB_OUTPUT
echo "Bump type: patch (default)"
fi
fi
- name: Bump version
id: version
run: |
# Read version from package.json
CURRENT_VERSION=$(node -p "require('./package.json').version")
echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
echo "Current version: $CURRENT_VERSION"
BUMP="${{ steps.bump_type.outputs.bump }}"
echo "Bumping version: $BUMP"
# Run the bump script
node scripts/bump-version.js "$BUMP" --yes
# Get new version
NEW_VERSION=$(node -p "require('./package.json').version")
echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
echo "New version: $NEW_VERSION"
- name: Commit version bump
run: |
git add package.json CHANGELOG.md
git commit -m "chore: bump version to v${{ steps.version.outputs.new_version }}"
git push origin main
- name: Create git tag for release
run: |
TAG_NAME="v${{ steps.version.outputs.new_version }}"
echo "Creating tag $TAG_NAME"
git tag -a "$TAG_NAME" -m "Release $TAG_NAME"
git push origin "$TAG_NAME"
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
@@ -36,14 +98,14 @@ jobs:
docker build \
--target test-runner \
--build-arg GIT_COMMIT=${{ github.sha }} \
-t ${{ env.IMAGE_NAME }}-test:${{ steps.version.outputs.version }} \
-t ${{ env.IMAGE_NAME }}-test:${{ steps.version.outputs.new_version }} \
.
- name: Run tests inside test-capable container
run: |
docker run --rm \
-e DATABASE_URL="postgresql://user:pass@localhost:5432/dummy" \
${{ env.IMAGE_NAME }}-test:${{ steps.version.outputs.version }} \
${{ env.IMAGE_NAME }}-test:${{ steps.version.outputs.new_version }} \
npm run test:run
- name: Build production image
@@ -51,37 +113,35 @@ jobs:
docker build \
--target runner \
--build-arg GIT_COMMIT=${{ github.sha }} \
-t ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.version }} \
-t ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.new_version }} \
-t ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest \
.
- name: Configure Git
run: |
git config user.name "Gitea Actions"
git config user.email "actions@gitea.com"
- name: Create git tag for release
run: |
git tag -a "v${{ steps.version.outputs.version }}" -m "Release v${{ steps.version.outputs.version }}"
git push origin "v${{ steps.version.outputs.version }}"
- name: Push Docker images
run: |
echo "Pushing to ${{ env.REGISTRY }}..."
# Check if we can authenticate to the registry
if docker login ${{ env.REGISTRY }} -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} 2>/dev/null; then
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.version }}
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
echo "Successfully pushed images to ${{ env.REGISTRY }}"
# Check if we can authenticate to the registry using DOCKER_LOGIN and DOCKER_PASSWORD secrets
if [ -n "${{ secrets.DOCKER_LOGIN }}" ] && [ -n "${{ secrets.DOCKER_PASSWORD }}" ]; then
if docker login ${{ env.REGISTRY }} -u ${{ secrets.DOCKER_LOGIN }} -p ${{ secrets.DOCKER_PASSWORD }} 2>/dev/null; then
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.new_version }}
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
echo "Successfully pushed images to ${{ env.REGISTRY }}"
else
echo "Warning: Docker login failed with provided credentials"
echo "Images built locally but not pushed to registry"
echo "Manual push required:"
echo " docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.new_version }}"
echo " docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest"
fi
else
echo "Warning: Could not authenticate to ${{ env.REGISTRY }}"
echo "Warning: DOCKER_LOGIN or DOCKER_PASSWORD secrets not configured"
echo "Images built locally but not pushed to registry"
echo "Manual push required:"
echo " docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.version }}"
echo " docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.version.outputs.new_version }}"
echo " docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest"
fi
- name: Deploy to dev (placeholder)
run: |
echo "Deploying version ${{ steps.version.outputs.version }} to dev environment..."
echo "Deploying version ${{ steps.version.outputs.new_version }} to dev environment..."
# TODO: Add actual deployment steps
+9 -35
View File
@@ -4,52 +4,26 @@ on:
push:
branches:
- '**'
- '!main' # Skip main branch (release workflow handles that)
pull_request:
branches:
- main
jobs:
unit-tests:
runs-on: ubuntu-latest
container:
image: node:20-alpine
options: --user root
# Skip if this is an auto-generated version bump commit (handled by release workflow)
if: "!contains(github.event.head_commit.message, 'chore: bump version')"
steps:
- name: Install system dependencies
run: |
apk add --no-cache bash git
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run unit tests
run: npm run test:run
# Acceptance tests that don't require DB read/write
# Only run on pull requests to main
safe-acceptance-tests:
runs-on: ubuntu-latest
needs: unit-tests
if: github.event_name == 'pull_request'
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run safe acceptance tests
# These tests should not read/write to the database
# They might test UI components, routing, or static content
run: npm run test:acceptance -- --grep "safe|static|ui|component"