mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-29 18:51:43 +02:00
Enabled Github CI
This commit is contained in:
maziggy
@@ -0,0 +1,20 @@
|
||||
# CODEOWNERS - Defines code owners who will be requested for review
|
||||
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
|
||||
|
||||
# Default owner for everything
|
||||
* @maziggy
|
||||
|
||||
# Backend code
|
||||
/backend/ @maziggy
|
||||
|
||||
# Frontend code
|
||||
/frontend/ @maziggy
|
||||
|
||||
# Infrastructure and deployment
|
||||
/Dockerfile* @maziggy
|
||||
/docker-compose*.yml @maziggy
|
||||
/.github/ @maziggy
|
||||
|
||||
# Documentation
|
||||
/*.md @maziggy
|
||||
/docs/ @maziggy
|
||||
@@ -0,0 +1,158 @@
|
||||
# Maintainer Guide
|
||||
|
||||
This document provides setup instructions for repository maintainers.
|
||||
|
||||
## Branch Protection Setup
|
||||
|
||||
To protect the `main` branch, go to **Settings > Rules > Rulesets > New ruleset > New branch ruleset**.
|
||||
|
||||
### Step 1: Basic Settings
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| Ruleset name | `Protect main` |
|
||||
| Enforcement status | `Active` |
|
||||
|
||||
### Step 2: Bypass List (optional)
|
||||
|
||||
Add yourself (`@maziggy`) to bypass if you want to push directly in emergencies.
|
||||
Set "Always" or "Pull requests only" based on preference.
|
||||
|
||||
### Step 3: Target Branches
|
||||
|
||||
Click **Add target** > **Include by pattern** and enter: `main`
|
||||
|
||||
### Step 4: Branch Rules
|
||||
|
||||
Enable these rules:
|
||||
|
||||
**Restrict deletions** - Prevents branch deletion
|
||||
|
||||
**Require a pull request before merging**
|
||||
- Required approvals: `1`
|
||||
- [x] Dismiss stale pull request approvals when new commits are pushed
|
||||
- [ ] Require review from Code Owners (optional)
|
||||
- [x] Require approval of the most recent reviewable push
|
||||
|
||||
**Require status checks to pass**
|
||||
- [x] Require branches to be up to date before merging
|
||||
- Add these status checks (they appear after CI runs once):
|
||||
- `Backend Lint`
|
||||
- `Backend Tests`
|
||||
- `Frontend Lint`
|
||||
- `Frontend Type Check`
|
||||
- `Frontend Tests`
|
||||
- `Frontend Build`
|
||||
- `Docker Build`
|
||||
|
||||
**Block force pushes** - Prevents history rewriting
|
||||
|
||||
### Optional (stricter)
|
||||
|
||||
- [ ] Require conversation resolution before merging
|
||||
- [ ] Require signed commits
|
||||
- [ ] Require linear history
|
||||
|
||||
## CI Workflow
|
||||
|
||||
The CI workflow (`.github/workflows/ci.yml`) runs on:
|
||||
- All pull requests to `main`
|
||||
- All pushes to `main`
|
||||
|
||||
### Jobs
|
||||
|
||||
| Job | Purpose | Required for PR |
|
||||
|-----|---------|-----------------|
|
||||
| `backend-lint` | Ruff linting + format check | Yes |
|
||||
| `backend-tests` | Unit tests | Yes |
|
||||
| `frontend-lint` | ESLint | Yes |
|
||||
| `frontend-typecheck` | TypeScript compilation | Yes |
|
||||
| `frontend-tests` | Vitest unit tests | Yes |
|
||||
| `frontend-build` | Vite production build | Yes |
|
||||
| `docker-build` | Docker image builds | Yes |
|
||||
|
||||
### Fixing CI Failures
|
||||
|
||||
**Backend lint failures:**
|
||||
```bash
|
||||
ruff check --fix backend/
|
||||
ruff format backend/
|
||||
```
|
||||
|
||||
**Frontend lint failures:**
|
||||
```bash
|
||||
cd frontend
|
||||
npm run lint -- --fix
|
||||
```
|
||||
|
||||
**Frontend type errors:**
|
||||
```bash
|
||||
cd frontend
|
||||
npx tsc --noEmit
|
||||
# Fix the errors shown
|
||||
```
|
||||
|
||||
**Frontend test failures:**
|
||||
```bash
|
||||
cd frontend
|
||||
npm run test:run
|
||||
# Fix failing tests
|
||||
```
|
||||
|
||||
## CODEOWNERS
|
||||
|
||||
The `CODEOWNERS` file automatically requests reviews from `@maziggy` for all changes.
|
||||
|
||||
To add more code owners:
|
||||
1. Edit `.github/CODEOWNERS`
|
||||
2. Add GitHub usernames with `@` prefix
|
||||
3. Assign specific paths to specific owners
|
||||
|
||||
Example:
|
||||
```
|
||||
/backend/ @maziggy @backend-contributor
|
||||
/frontend/ @maziggy @frontend-contributor
|
||||
```
|
||||
|
||||
## Release Process
|
||||
|
||||
1. Update version in `pyproject.toml`
|
||||
2. Update `CHANGELOG.md`
|
||||
3. Create a PR with these changes
|
||||
4. After merge, tag the release:
|
||||
```bash
|
||||
git tag v0.1.x
|
||||
git push origin v0.1.x
|
||||
```
|
||||
5. Run `docker-publish.sh` to publish Docker image
|
||||
|
||||
## Dependabot (Optional)
|
||||
|
||||
To enable automated dependency updates, create `.github/dependabot.yml`:
|
||||
|
||||
```yaml
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "pip"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
groups:
|
||||
python-dependencies:
|
||||
patterns:
|
||||
- "*"
|
||||
|
||||
- package-ecosystem: "npm"
|
||||
directory: "/frontend"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
groups:
|
||||
npm-dependencies:
|
||||
patterns:
|
||||
- "*"
|
||||
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
```
|
||||
@@ -0,0 +1,185 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
env:
|
||||
PYTHON_VERSION: '3.11'
|
||||
NODE_VERSION: '20'
|
||||
|
||||
# Cancel in-progress runs for the same branch
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
# ============================================================================
|
||||
# Backend Checks
|
||||
# ============================================================================
|
||||
|
||||
backend-lint:
|
||||
name: Backend Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install ruff
|
||||
run: pip install ruff
|
||||
|
||||
- name: Run ruff check
|
||||
run: ruff check backend/
|
||||
|
||||
- name: Run ruff format check
|
||||
run: ruff format --check backend/
|
||||
|
||||
backend-tests:
|
||||
name: Backend Tests
|
||||
runs-on: ubuntu-latest
|
||||
needs: backend-lint
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Cache pip
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pip-
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
pip install pytest pytest-asyncio pytest-cov
|
||||
|
||||
- name: Run unit tests
|
||||
run: |
|
||||
cd backend
|
||||
python -m pytest tests/unit/ -v --tb=short -m "not slow"
|
||||
|
||||
# ============================================================================
|
||||
# Frontend Checks
|
||||
# ============================================================================
|
||||
|
||||
frontend-lint:
|
||||
name: Frontend Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
working-directory: frontend
|
||||
run: npm ci
|
||||
|
||||
- name: Run ESLint
|
||||
working-directory: frontend
|
||||
run: npm run lint
|
||||
|
||||
frontend-typecheck:
|
||||
name: Frontend Type Check
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
working-directory: frontend
|
||||
run: npm ci
|
||||
|
||||
- name: Run TypeScript check
|
||||
working-directory: frontend
|
||||
run: npx tsc --noEmit
|
||||
|
||||
frontend-tests:
|
||||
name: Frontend Tests
|
||||
runs-on: ubuntu-latest
|
||||
needs: [frontend-lint, frontend-typecheck]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
working-directory: frontend
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests
|
||||
working-directory: frontend
|
||||
run: npm run test:run
|
||||
|
||||
frontend-build:
|
||||
name: Frontend Build
|
||||
runs-on: ubuntu-latest
|
||||
needs: [frontend-tests]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
working-directory: frontend
|
||||
run: npm ci
|
||||
|
||||
- name: Build
|
||||
working-directory: frontend
|
||||
run: npm run build
|
||||
|
||||
# ============================================================================
|
||||
# Docker Build (optional, for release confidence)
|
||||
# ============================================================================
|
||||
|
||||
docker-build:
|
||||
name: Docker Build
|
||||
runs-on: ubuntu-latest
|
||||
needs: [backend-tests, frontend-build]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build Docker image
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
push: false
|
||||
tags: bambuddy:test
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
Reference in New Issue
Block a user