Compare commits
5 Commits
v0.1.5
...
ff7461973a
| Author | SHA1 | Date | |
|---|---|---|---|
| ff7461973a | |||
| 9b69cb84e3 | |||
| 5c9b98a926 | |||
| 73ba929e36 | |||
| c9cd00a055 |
@@ -0,0 +1,124 @@
|
||||
# Gitea Actions Workflow Architecture
|
||||
|
||||
This document describes the workflow architecture for version bumping 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
|
||||
|
||||
## Workflow Files
|
||||
|
||||
### 1. `.gitea/workflows/pr.yml` (Pull Request Workflow)
|
||||
|
||||
**Trigger**: Pull requests to `main` branch
|
||||
|
||||
**Purpose**:
|
||||
- Run unit tests on every PR
|
||||
- Analyze commits to determine bump type (major/minor/patch)
|
||||
- Comment the suggested bump type on the PR
|
||||
|
||||
**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)
|
||||
|
||||
**Trigger**: Pushes to `main` branch (after PR merge)
|
||||
|
||||
**Purpose**:
|
||||
- Determine bump type from merge commit or PR commits
|
||||
- Bump version in `package.json` and `CHANGELOG.md`
|
||||
- Commit the version bump
|
||||
- Create git tag for the release
|
||||
- Run tests inside Docker container
|
||||
- Build production Docker image
|
||||
- Push images to registry
|
||||
- Deploy to dev environment
|
||||
|
||||
**Key Features**:
|
||||
- Skips commits that are auto-generated version bumps
|
||||
- Uses `DOCKER_LOGIN` and `DOCKER_PASSWORD` secrets for registry auth
|
||||
- Handles existing git tags gracefully
|
||||
|
||||
## Version Bump Logic
|
||||
|
||||
### Step 1: PR Analysis (pr.yml)
|
||||
When a PR is opened or updated:
|
||||
1. Fetch the merge base with `main`
|
||||
2. Analyze all commits in the PR
|
||||
3. Determine bump type based on commit messages:
|
||||
- Breaking changes → major
|
||||
- Features → minor
|
||||
- Fixes → patch
|
||||
4. Comment the suggested bump type on the PR
|
||||
|
||||
### Step 2: Release (release.yml)
|
||||
When a PR is merged to `main`:
|
||||
1. Check if the commit is an auto-bump (skip if so)
|
||||
2. Analyze the merge commit message or PR commits
|
||||
3. Run `node scripts/bump-version.js <type> --yes`
|
||||
4. Commit the version bump changes
|
||||
5. Create and push git tag
|
||||
6. Build and push Docker images
|
||||
|
||||
## Environment Variables & Secrets
|
||||
|
||||
### Required Secrets
|
||||
- `DOCKER_LOGIN`: Username for Docker registry authentication
|
||||
- `DOCKER_PASSWORD`: Password for Docker registry authentication
|
||||
- `GITEA_TOKEN` (optional): For pushing back to repo (if needed)
|
||||
|
||||
### Environment Variables
|
||||
- `REGISTRY`: Docker registry URL (default: `docker.notsosm.art`)
|
||||
- `IMAGE_NAME`: Docker image name (default: `euchre-camp`)
|
||||
|
||||
## Example Workflow
|
||||
|
||||
### Scenario: Feature PR
|
||||
1. Developer opens PR with commits:
|
||||
- "feat: add new feature"
|
||||
- "fix: resolve edge case"
|
||||
2. PR workflow runs:
|
||||
- Unit tests pass
|
||||
- Bump type analysis suggests "minor"
|
||||
- Comment posted on PR: "Suggested bump: MINOR"
|
||||
3. Developer merges PR
|
||||
4. Release workflow runs:
|
||||
- Detects minor bump from commits
|
||||
- Bumps version from 0.1.1 → 0.2.0
|
||||
- Commits version bump
|
||||
- Creates tag v0.2.0
|
||||
- Builds and pushes Docker image
|
||||
- Deploys to dev
|
||||
|
||||
### Scenario: Breaking Change PR
|
||||
1. Developer opens PR with commit:
|
||||
- "feat!: breaking API change"
|
||||
2. PR workflow runs:
|
||||
- Detects breaking change marker
|
||||
- Suggests "major" bump
|
||||
- Comments on PR
|
||||
3. Developer merges PR
|
||||
4. Release workflow runs:
|
||||
- Detects major bump
|
||||
- Bumps version from 0.1.1 → 1.0.0
|
||||
- Creates tag v1.0.0
|
||||
- Proceeds with build and deploy
|
||||
|
||||
## Benefits
|
||||
|
||||
1. **No CI Loops**: Version bump commits are detected and skipped
|
||||
2. **Clear Communication**: PR comments inform developers of impact
|
||||
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
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
- Add GitHub/Gitea Release creation
|
||||
- Slack/Discord notifications on release
|
||||
- Automatic rollback on test failure
|
||||
- Multi-environment deployment (dev/staging/prod)
|
||||
@@ -0,0 +1,70 @@
|
||||
name: Pull Request
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
analyze-bump-type:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
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
|
||||
});
|
||||
@@ -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
|
||||
|
||||
@@ -5,9 +5,6 @@ on:
|
||||
branches:
|
||||
- '**'
|
||||
- '!main' # Skip main branch (release workflow handles that)
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
unit-tests:
|
||||
@@ -28,28 +25,3 @@ jobs:
|
||||
|
||||
- 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"
|
||||
|
||||
@@ -1,3 +1,22 @@
|
||||
## [0.1.2] - 2026-04-01
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- fix: handle Docker registry authentication gracefully in release workflow
|
||||
- fix: run unit tests on branch commits, skip main branch
|
||||
- feat: add test workflow for every commit
|
||||
- trigger: release with test-capable image
|
||||
- feat: build test-capable image, run tests, then build production image
|
||||
- trigger: release workflow
|
||||
- fix: release workflow should not commit, only tag
|
||||
- trigger: manual workflow trigger for docker.notsosm.art
|
||||
- fix: update Docker build script to use docker.notsosm.art registry
|
||||
- fix: update workflow to use docker.notsosm.art registry
|
||||
- trigger: manual workflow trigger
|
||||
- fix: update workflow to use correct Docker registries
|
||||
- feat: add Gitea Actions release workflow
|
||||
- feat: add view match link to admin matches page
|
||||
|
||||
## [0.1.1] - 2026-04-01
|
||||
|
||||
### Patch Changes
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "euchre_camp",
|
||||
"version": "0.1.1",
|
||||
"version": "0.1.2",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "NEXT_PUBLIC_GIT_COMMIT=$(git rev-parse --short HEAD) next dev",
|
||||
|
||||
@@ -17,6 +17,7 @@ const path = require('path');
|
||||
// Parse command line arguments
|
||||
const args = process.argv.slice(2);
|
||||
const forcedVersion = args[0]; // e.g., "0.2.0" or "patch/minor/major"
|
||||
const skipConfirm = args.includes('--yes') || args.includes('-y'); // Skip confirmation prompt
|
||||
|
||||
// Paths
|
||||
const packageJsonPath = path.join(__dirname, '..', 'package.json');
|
||||
|
||||
Reference in New Issue
Block a user