fix: version bumping and Docker registry authentication #17

Merged
david merged 17 commits from fix/workflow-tag-exists into main 2026-04-01 05:03:16 +00:00
3 changed files with 109 additions and 8 deletions
Showing only changes of commit 6b70c3f388 - Show all commits
+50 -7
View File
@@ -1,12 +1,13 @@
# Gitea Actions Workflow Architecture
This document describes the workflow architecture for version bumping and releases.
This document describes the workflow architecture for version bumping, testing, and releases.
## Overview
The workflow architecture uses a two-step process:
1. **PR Workflow**: Analyzes commits and suggests bump type
2. **Release Workflow**: Bumps version, creates tags, and builds Docker images on merge
The workflow architecture uses a three-step process:
1. **PR Workflow**: Runs tests on PRs and analyzes commits for bump type
2. **Test Workflow**: Runs unit tests on all branch pushes (except version bumps)
3. **Release Workflow**: Bumps version, creates tags, builds Docker images, and deploys on main branch pushes
## Workflow Files
@@ -15,16 +16,36 @@ The workflow architecture uses a two-step process:
**Trigger**: Pull requests to `main` branch
**Purpose**:
- Run unit tests on every PR
- Run unit tests on every PR (fast feedback)
- Run acceptance tests with SQLite database
- Analyze commits to determine bump type (major/minor/patch)
- Comment the suggested bump type on the PR
**Test Execution**:
- **Unit Tests**: Run first, fast execution
- **Acceptance Tests**: Run after unit tests pass, uses SQLite database
- **Database**: SQLite with `DATABASE_URL=file:./prisma/ci.db`
- **Secrets**: Uses `BETTER_AUTH_SECRET` for authentication
**Bump Type Detection**:
- **Major**: Breaking changes detected (`BREAKING CHANGE` or `!:` in commit messages)
- **Minor**: Feature commits detected (`feat:` prefix)
- **Patch**: Default for fixes and other changes
### 2. `.gitea/workflows/release.yml` (Release Workflow)
### 2. `.gitea/workflows/test.yml` (Test Workflow)
**Trigger**: Pushes to any branch (including main)
**Purpose**:
- Run unit tests on all branch pushes
- Skip auto-generated version bump commits (handled by release workflow)
**Key Features**:
- Runs on all branches including main
- Skips commits with "chore: bump version" message
- Fast execution for quick feedback
### 3. `.gitea/workflows/release.yml` (Release Workflow)
**Trigger**: Pushes to `main` branch (after PR merge)
@@ -33,7 +54,7 @@ The workflow architecture uses a two-step process:
- Bump version in `package.json` and `CHANGELOG.md`
- Commit the version bump
- Create git tag for the release
- Run tests inside Docker container
- Run tests inside Docker container (with PostgreSQL)
- Build production Docker image
- Push images to registry
- Deploy to dev environment
@@ -42,6 +63,7 @@ The workflow architecture uses a two-step process:
- Skips commits that are auto-generated version bumps
- Uses `DOCKER_LOGIN` and `DOCKER_PASSWORD` secrets for registry auth
- Handles existing git tags gracefully
- Runs comprehensive tests in production-like environment
## Version Bump Logic
@@ -108,6 +130,25 @@ When a PR is merged to `main`:
- Creates tag v1.0.0
- Proceeds with build and deploy
## Database Configuration for CI
### SQLite for CI Acceptance Tests
- **Why SQLite**: No database server required, perfect for CI environments
- **Usage**: PR workflow runs acceptance tests with SQLite database
- **Configuration**: `DATABASE_PROVIDER=sqlite`, `DATABASE_URL=file:./prisma/ci.db`
- **Benefits**: Fast, isolated, no external dependencies
### PostgreSQL for Production
- **Usage**: Release workflow runs tests in Docker with PostgreSQL
- **Configuration**: Uses dummy PostgreSQL URL for Docker builds
- **Benefits**: Production-like environment, catches PostgreSQL-specific issues
### Database Provider Detection
The application automatically detects the database provider:
- `DATABASE_PROVIDER` environment variable (defaults to `sqlite`)
- `prisma.ts` conditionally uses PrismaPg adapter for PostgreSQL
- Better Auth configured with appropriate provider
## Benefits
1. **No CI Loops**: Version bump commits are detected and skipped
@@ -115,6 +156,8 @@ When a PR is merged to `main`:
3. **Semantic Versioning**: Automated adherence to semver rules
4. **Traceability**: Git tags and changelog reflect all changes
5. **Safe Releases**: Tests run before version bump and deployment
6. **Fast CI**: SQLite tests run quickly without database server setup
7. **Comprehensive Testing**: Both unit and acceptance tests in PR workflow
## Future Enhancements
+57
View File
@@ -6,8 +6,65 @@ on:
- main
jobs:
unit-tests:
runs-on: ubuntu-latest
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 unit tests
run: npm run test:run
acceptance-tests:
runs-on: ubuntu-latest
needs: unit-tests
env:
DATABASE_PROVIDER: sqlite
DATABASE_URL: file:./prisma/ci.db
BETTER_AUTH_SECRET: test-secret-key-for-ci-only
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: 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
+2 -1
View File
@@ -4,11 +4,12 @@ on:
push:
branches:
- '**'
- '!main' # Skip main branch (release workflow handles that)
jobs:
unit-tests:
runs-on: ubuntu-latest
# 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: Checkout code