refactor: revert CI image approach and use standard npm ci in workflows
The CI image approach with pre-installed dependencies doesn't work with Gitea Actions due to workspace mounting issues. When Gitea Actions runs a container job, it mounts the workspace at a specific path (e.g., /workspace/david/euchre_camp), which hides the container's /app directory where dependencies were installed. Changes: - Reverted pr.yml unit-tests to use node:20-alpine with npm ci - Updated pr.yml acceptance-tests to use mcr.microsoft.com/playwright image with npm ci - Updated test.yml to use node:20-alpine with npm ci - Removed ci-image-builder.yml workflow - Removed Dockerfile.ci and build-ci-image.sh - Updated AGENTS.md and README.md to document the deprecation - Updated justfile to remove CI image commands The standard approach of running npm ci in each workflow is the recommended approach for Gitea Actions.
This commit is contained in:
@@ -1,80 +0,0 @@
|
|||||||
# CI Image Builder Workflow
|
|
||||||
# Automatically builds and pushes CI images when dependencies change
|
|
||||||
# Uses GitHub Container Registry (GHCR) or any container registry
|
|
||||||
|
|
||||||
name: CI Image Builder
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- 'package.json'
|
|
||||||
- 'package-lock.json'
|
|
||||||
- 'Dockerfile.ci'
|
|
||||||
- '.gitea/workflows/ci-image-builder.yml'
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
force_rebuild:
|
|
||||||
description: 'Force rebuild even if no changes detected'
|
|
||||||
required: false
|
|
||||||
default: 'false'
|
|
||||||
type: boolean
|
|
||||||
|
|
||||||
env:
|
|
||||||
# Use your existing Docker registry
|
|
||||||
REGISTRY: docker.notsosm.art
|
|
||||||
IMAGE_NAME: euchre-camp-ci-runner
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-ci-image:
|
|
||||||
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:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Build CI image
|
|
||||||
run: |
|
|
||||||
docker build \
|
|
||||||
-f Dockerfile.ci \
|
|
||||||
-t ${{ env.IMAGE_NAME }}:latest \
|
|
||||||
-t ${{ env.IMAGE_NAME }}:$(git rev-parse --short HEAD) \
|
|
||||||
.
|
|
||||||
|
|
||||||
- name: Test CI image
|
|
||||||
run: |
|
|
||||||
docker run --rm \
|
|
||||||
${{ env.IMAGE_NAME }}:latest \
|
|
||||||
sh -c "node --version && npm --version && npx prisma --version"
|
|
||||||
|
|
||||||
- name: Push to registry
|
|
||||||
run: |
|
|
||||||
echo "Pushing 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 tag ${{ env.IMAGE_NAME }}:latest ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
|
|
||||||
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
|
|
||||||
echo "Successfully pushed CI image to ${{ env.REGISTRY }}"
|
|
||||||
else
|
|
||||||
echo "Warning: Docker login failed with provided credentials"
|
|
||||||
echo "CI image built locally but not pushed to registry"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
echo "Warning: DOCKER_LOGIN or DOCKER_PASSWORD secrets not configured"
|
|
||||||
echo "CI image built locally but not pushed to registry"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Show usage instructions
|
|
||||||
run: |
|
|
||||||
echo "CI Image built successfully!"
|
|
||||||
echo ""
|
|
||||||
echo "To use in workflows:"
|
|
||||||
echo " container:"
|
|
||||||
echo " image: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest"
|
|
||||||
+16
-13
@@ -9,19 +9,15 @@ jobs:
|
|||||||
unit-tests:
|
unit-tests:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container:
|
container:
|
||||||
image: docker.notsosm.art/euchre-camp-ci-runner:latest
|
image: node:20-alpine
|
||||||
options: --user root
|
options: --user root
|
||||||
env:
|
|
||||||
NODE_PATH: /workspace/david/euchre_camp/node_modules
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Link node_modules from container
|
- name: Install dependencies
|
||||||
run: |
|
run: npm ci
|
||||||
# Create symlink from container's node_modules to workspace
|
|
||||||
ln -sf /app/node_modules /workspace/david/euchre_camp/node_modules
|
|
||||||
|
|
||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
run: npm run test:run
|
run: npm run test:run
|
||||||
@@ -30,22 +26,29 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: unit-tests
|
needs: unit-tests
|
||||||
container:
|
container:
|
||||||
image: docker.notsosm.art/euchre-camp-ci-runner:latest
|
image: mcr.microsoft.com/playwright:v1.58.0-jammy
|
||||||
options: --user root
|
options: --user root
|
||||||
env:
|
env:
|
||||||
DATABASE_PROVIDER: sqlite
|
DATABASE_PROVIDER: sqlite
|
||||||
DATABASE_URL: file:./prisma/ci.db
|
DATABASE_URL: file:./prisma/ci.db
|
||||||
BETTER_AUTH_SECRET: test-secret-key-for-ci-only
|
BETTER_AUTH_SECRET: test-secret-key-for-ci-only
|
||||||
NODE_PATH: /workspace/david/euchre_camp/node_modules
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Link node_modules from container
|
- name: Setup Node.js
|
||||||
run: |
|
uses: actions/setup-node@v4
|
||||||
# Create symlink from container's node_modules to workspace
|
with:
|
||||||
ln -sf /app/node_modules /workspace/david/euchre_camp/node_modules
|
node-version: '20'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Generate Prisma client
|
||||||
|
run: npx prisma generate
|
||||||
|
env:
|
||||||
|
DATABASE_URL: postgresql://user:pass@localhost:5432/dummy
|
||||||
|
|
||||||
- name: Setup SQLite database
|
- name: Setup SQLite database
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
@@ -9,21 +9,17 @@ jobs:
|
|||||||
unit-tests:
|
unit-tests:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container:
|
container:
|
||||||
image: docker.notsosm.art/euchre-camp-ci-runner:latest
|
image: node:20-alpine
|
||||||
options: --user root
|
options: --user root
|
||||||
# Skip if this is an auto-generated version bump commit (handled by release workflow)
|
# Skip if this is an auto-generated version bump commit (handled by release workflow)
|
||||||
if: "!contains(github.event.head_commit.message, 'chore: bump version')"
|
if: "!contains(github.event.head_commit.message, 'chore: bump version')"
|
||||||
env:
|
|
||||||
NODE_PATH: /workspace/david/euchre_camp/node_modules
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Link node_modules from container
|
- name: Install dependencies
|
||||||
run: |
|
run: npm ci
|
||||||
# Create symlink from container's node_modules to workspace
|
|
||||||
ln -sf /app/node_modules /workspace/david/euchre_camp/node_modules
|
|
||||||
|
|
||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
run: npm run test:run
|
run: npm run test:run
|
||||||
|
|||||||
@@ -129,23 +129,26 @@ DATABASE_PROVIDER=sqlite DATABASE_URL=file:./prisma/ci.db npm run test:acceptanc
|
|||||||
|
|
||||||
### CI Runner Image
|
### CI Runner Image
|
||||||
|
|
||||||
To speed up CI runs, the project uses a pre-built CI runner image with all dependencies pre-installed.
|
**Note:** The CI runner image approach has been deprecated for Gitea Actions workflows.
|
||||||
|
|
||||||
**Building the CI image locally:**
|
The original attempt to use a pre-built CI runner image with pre-installed dependencies encountered fundamental issues with how Gitea Actions handles workspace mounting. When Gitea Actions runs a container job, it mounts the workspace at a specific path (e.g., `/workspace/david/euchre_camp`), which hides the container's `/app` directory where dependencies were installed.
|
||||||
```bash
|
|
||||||
./scripts/build-ci-image.sh [tag]
|
|
||||||
```
|
|
||||||
|
|
||||||
**Using the CI image:**
|
**Current Approach:**
|
||||||
- Workflows automatically use `ghcr.io/<repo>/ci-runner:latest` when available
|
- Workflows use standard `node:20-alpine` or `mcr.microsoft.com/playwright` containers
|
||||||
- Falls back to `node:20-alpine` if image is not found
|
- Dependencies are installed via `npm ci` in each workflow run
|
||||||
- Image is automatically rebuilt when `package.json` changes
|
- This is the recommended approach for Gitea Actions
|
||||||
|
|
||||||
**CI Image contains:**
|
**Why the CI image approach doesn't work:**
|
||||||
- Node.js 20 Alpine
|
1. Dockerfile.ci installs dependencies in `/app`
|
||||||
- All npm dependencies pre-installed
|
2. Gitea Actions mounts workspace at `/workspace/david/euchre_camp`
|
||||||
- Prisma client pre-generated
|
3. Workspace mount hides the `/app` directory
|
||||||
- System tools (bash, git, python, make, g++)
|
4. Symlinks from `/app/node_modules` don't work because `/app` is hidden
|
||||||
|
|
||||||
|
**Alternative for performance:**
|
||||||
|
If CI performance becomes an issue, consider:
|
||||||
|
- Using GitHub Actions cache for node_modules
|
||||||
|
- Using a self-hosted runner with persistent workspace
|
||||||
|
- Using the main Dockerfile's `test-runner` target for release workflows (which works because it builds a complete image)
|
||||||
|
|
||||||
### CI/CD Pipeline
|
### CI/CD Pipeline
|
||||||
The project uses Gitea Actions for continuous integration:
|
The project uses Gitea Actions for continuous integration:
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
# CI Runner Image for EuchreCamp
|
|
||||||
# Pre-installed with all dependencies to speed up CI runs
|
|
||||||
# This image is rebuilt automatically when package.json changes
|
|
||||||
|
|
||||||
FROM node:20-alpine
|
|
||||||
|
|
||||||
# Install system dependencies needed for various tasks
|
|
||||||
RUN apk add --no-cache \
|
|
||||||
bash \
|
|
||||||
git \
|
|
||||||
curl \
|
|
||||||
python3 \
|
|
||||||
make \
|
|
||||||
g++ \
|
|
||||||
&& rm -rf /var/cache/apk/*
|
|
||||||
|
|
||||||
# Set working directory
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
# Copy package files first (for better caching)
|
|
||||||
COPY package*.json ./
|
|
||||||
|
|
||||||
# Install ALL dependencies including dev dependencies
|
|
||||||
# This is done at image build time, not at CI runtime
|
|
||||||
RUN npm ci
|
|
||||||
|
|
||||||
# Copy Prisma schema (needed for Prisma client generation)
|
|
||||||
COPY prisma/schema.prisma ./prisma/
|
|
||||||
|
|
||||||
# Generate Prisma client
|
|
||||||
RUN npx prisma generate
|
|
||||||
|
|
||||||
# Copy the rest of the application
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Set environment variables for CI environment
|
|
||||||
ENV NODE_ENV=production
|
|
||||||
ENV DATABASE_PROVIDER=sqlite
|
|
||||||
ENV DATABASE_URL=file:./prisma/ci.db
|
|
||||||
ENV BETTER_AUTH_SECRET=test-secret-key-for-ci-only
|
|
||||||
|
|
||||||
# Verify installations
|
|
||||||
RUN node --version && npm --version && git --version && npx prisma --version
|
|
||||||
|
|
||||||
# Default command
|
|
||||||
CMD ["/bin/sh"]
|
|
||||||
@@ -368,35 +368,27 @@ The application uses Gitea Actions for continuous integration and deployment:
|
|||||||
- Unit tests for quick feedback
|
- Unit tests for quick feedback
|
||||||
- Skips auto-generated version bumps
|
- Skips auto-generated version bumps
|
||||||
|
|
||||||
3. **Release Workflow** (`.gitea/workflows/release.yml`): Runs on main branch pushes
|
3. **Release Workflow** (`.gitea/workflows/release.yml`): Runs on main branch pushes
|
||||||
- Version bumping and tagging
|
- Version bumping and tagging
|
||||||
- Docker image building and testing
|
- Docker image building and testing
|
||||||
- Registry push and deployment
|
- Registry push and deployment
|
||||||
|
|
||||||
4. **CI Image Builder** (`.gitea/workflows/ci-image-builder.yml`): Runs when dependencies change
|
|
||||||
- Automatically builds CI runner image with all dependencies pre-installed
|
|
||||||
- Triggered by changes to `package.json`, `package-lock.json`, or `Dockerfile.ci`
|
|
||||||
|
|
||||||
### CI Runner Image
|
### CI Runner Image
|
||||||
|
|
||||||
To avoid installing dependencies on every workflow run, we use a pre-built CI runner image:
|
**Note:** The CI runner image approach has been deprecated for Gitea Actions workflows.
|
||||||
|
|
||||||
**Dockerfile.ci** - Contains:
|
The original attempt to use a pre-built CI runner image with pre-installed dependencies encountered fundamental issues with how Gitea Actions handles workspace mounting. When Gitea Actions runs a container job, it mounts the workspace at a specific path (e.g., `/workspace/david/euchre_camp`), which hides the container's `/app` directory where dependencies were installed.
|
||||||
- Node.js 20 Alpine
|
|
||||||
- All npm dependencies pre-installed
|
|
||||||
- Prisma client pre-generated
|
|
||||||
- System tools (bash, git, python, make, g++)
|
|
||||||
|
|
||||||
**Automatic Rebuilding:**
|
**Current Approach:**
|
||||||
- The CI image is automatically rebuilt when `package.json` or `package-lock.json` changes
|
- Workflows use standard `node:20-alpine` or `mcr.microsoft.com/playwright` containers
|
||||||
- Images are tagged with commit SHA for traceability
|
- Dependencies are installed via `npm ci` in each workflow run
|
||||||
- Falls back to `node:20-alpine` if custom image is not available
|
- This is the recommended approach for Gitea Actions
|
||||||
|
|
||||||
**Manual Build:**
|
**Why the CI image approach doesn't work:**
|
||||||
```bash
|
1. Dockerfile.ci installs dependencies in `/app`
|
||||||
docker build -f Dockerfile.ci -t euchre-camp-ci:latest .
|
2. Gitea Actions mounts workspace at `/workspace/david/euchre_camp`
|
||||||
docker run --rm euchre-camp-ci:latest node --version
|
3. Workspace mount hides the `/app` directory
|
||||||
```
|
4. Symlinks from `/app/node_modules` don't work because `/app` is hidden
|
||||||
|
|
||||||
### Database Strategy for CI
|
### Database Strategy for CI
|
||||||
- **CI Tests**: SQLite database (fast, no server required)
|
- **CI Tests**: SQLite database (fast, no server required)
|
||||||
@@ -410,9 +402,6 @@ npm run test:run
|
|||||||
|
|
||||||
# Run acceptance tests with SQLite
|
# Run acceptance tests with SQLite
|
||||||
DATABASE_PROVIDER=sqlite DATABASE_URL=file:./prisma/ci.db npm run test:acceptance
|
DATABASE_PROVIDER=sqlite DATABASE_URL=file:./prisma/ci.db npm run test:acceptance
|
||||||
|
|
||||||
# Run tests in CI container (if built)
|
|
||||||
docker run --rm -v $(pwd):/app -w /app euchre-camp-ci:latest npm run test:run
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker Deployment
|
## Docker Deployment
|
||||||
|
|||||||
@@ -173,16 +173,6 @@ pr-validate: lint typecheck test-unit test-acceptance-sqlite
|
|||||||
ci-postgres: lint typecheck test-unit test-acceptance-postgres docker-build
|
ci-postgres: lint typecheck test-unit test-acceptance-postgres docker-build
|
||||||
@echo "CI Pipeline with PostgreSQL completed successfully!"
|
@echo "CI Pipeline with PostgreSQL completed successfully!"
|
||||||
|
|
||||||
# --- CI Image ---
|
|
||||||
|
|
||||||
# Build CI runner image locally
|
|
||||||
ci-build:
|
|
||||||
@./scripts/build-ci-image.sh
|
|
||||||
|
|
||||||
# Build CI runner image with custom tag
|
|
||||||
ci-build-tag TAG:
|
|
||||||
@./scripts/build-ci-image.sh {{TAG}}
|
|
||||||
|
|
||||||
# --- Utilities ---
|
# --- Utilities ---
|
||||||
|
|
||||||
# Show help information
|
# Show help information
|
||||||
@@ -256,6 +246,8 @@ workflow-status:
|
|||||||
@echo "PR Workflow: Runs unit + acceptance tests on pull requests"
|
@echo "PR Workflow: Runs unit + acceptance tests on pull requests"
|
||||||
@echo "Test Workflow: Runs unit tests on all branch pushes"
|
@echo "Test Workflow: Runs unit tests on all branch pushes"
|
||||||
@echo "Release Workflow: Runs on main branch pushes (version bump + Docker build)"
|
@echo "Release Workflow: Runs on main branch pushes (version bump + Docker build)"
|
||||||
|
@echo ""
|
||||||
|
@echo "Note: CI image approach deprecated due to Gitea Actions workspace mounting"
|
||||||
|
|
||||||
# Check current database provider
|
# Check current database provider
|
||||||
db-status:
|
db-status:
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# Build and test the CI runner image locally
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
IMAGE_NAME="euchre-camp-ci-runner"
|
|
||||||
TAG="${1:-latest}"
|
|
||||||
|
|
||||||
echo "Building CI runner image..."
|
|
||||||
echo "Image: ${IMAGE_NAME}:${TAG}"
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
# Build the image
|
|
||||||
docker build \
|
|
||||||
-f Dockerfile.ci \
|
|
||||||
-t ${IMAGE_NAME}:${TAG} \
|
|
||||||
.
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "✅ Image built successfully!"
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
# Test the image
|
|
||||||
echo "Testing CI image..."
|
|
||||||
docker run --rm ${IMAGE_NAME}:${TAG} sh -c "
|
|
||||||
echo 'Node.js version:' && node --version
|
|
||||||
echo 'npm version:' && npm --version
|
|
||||||
echo 'Git version:' && git --version
|
|
||||||
echo 'Prisma version:' && npx prisma --version
|
|
||||||
echo ''
|
|
||||||
echo 'Installed packages (top 10):'
|
|
||||||
npm list --depth=0 | head -10
|
|
||||||
"
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "✅ CI image is ready to use!"
|
|
||||||
echo ""
|
|
||||||
echo "To use in GitHub Actions/Gitea Actions:"
|
|
||||||
echo " container:"
|
|
||||||
echo " image: docker.notsosm.art/${IMAGE_NAME}:${TAG}"
|
|
||||||
echo ""
|
|
||||||
echo "To push to registry:"
|
|
||||||
echo " docker tag ${IMAGE_NAME}:${TAG} docker.notsosm.art/${IMAGE_NAME}:${TAG}"
|
|
||||||
echo " docker push docker.notsosm.art/${IMAGE_NAME}:${TAG}"
|
|
||||||
Reference in New Issue
Block a user