Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit e79f84f

Browse files
author
Nick Sullivan
committed
🚀 Enhance CI/CD pipeline for AICodeBot
- Restructure workflow with lint, test, build, and publish jobs - Add caching for dependencies and test results - Implement skip-deploy feature with [skip-deploy] tag - Use uv for faster package management - Enable publishing to PyPI on version tags - Improve code quality with ruff linter and formatter - Update Python versions and add matrix testing
1 parent 6ba0cb4 commit e79f84f

1 file changed

Lines changed: 163 additions & 26 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 163 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,187 @@
11
---
2-
# Build and test the code
3-
name: Build
2+
# =====================================================================
3+
# 🤖 AICodeBot CI/CD Pipeline 🤖
4+
# =====================================================================
5+
#
6+
# This workflow handles the continuous integration and deployment of
7+
# AICodeBot, the AI-powered coding assistant.
8+
#
9+
# 📊 Flow Structure:
10+
# -----------------
11+
# 1. lint-code: Quick static code analysis with ruff
12+
# 2. test-python: Python backend tests
13+
# 3. build-package: Build Python package for distribution
14+
# 4. publish-package: Publish to PyPI (only on tags)
15+
#
16+
# 🔄 Job Dependencies:
17+
# ------------------
18+
# The publish-package job only runs when all other jobs complete successfully
19+
# and only on version tags (v*).
20+
#
21+
# 🎯 Skip Deploy Feature:
22+
# ---------------------
23+
# Add [skip-deploy] anywhere in your commit message to skip PyPI publishing.
24+
# This is useful for documentation updates, test changes, or other non-production changes.
25+
# Example: "📝 Update README with examples [skip-deploy]"
26+
#
27+
# 💫 Caching Strategy:
28+
# ------------------
29+
# - GitHub Actions cache for pip/uv dependencies
30+
# - Pytest cache for faster test runs
31+
#
32+
# Remember: Helping developers code better, one commit at a time! 🚀
33+
# =====================================================================
434

5-
on: [push, pull_request]
35+
name: Build AICodeBot 🤖
36+
on:
37+
# Run on PRs
38+
pull_request:
39+
branches: [main]
40+
41+
# Run on pushes to main
42+
push:
43+
branches: [main]
44+
tags: ['v*']
45+
46+
# Allow manual triggers
47+
workflow_dispatch:
48+
49+
permissions: read-all
50+
51+
concurrency:
52+
group: ${{ github.workflow }}-${{ github.ref }}
53+
cancel-in-progress: true
654

755
jobs:
8-
pre-commit:
9-
name: Pre-commit (linting)
56+
lint-code:
57+
name: 🧹 Lint code
1058
runs-on: ubuntu-latest
1159
timeout-minutes: 5
1260

1361
steps:
1462
- name: Checkout Code
15-
uses: actions/checkout@v4
63+
uses: actions/checkout@v5
64+
65+
- name: Setup Python
66+
uses: actions/setup-python@v5
67+
with:
68+
python-version: "3.13"
69+
70+
- name: Install uv (Rust-powered Python package manager)
71+
run: |
72+
curl -LsSf https://astral.sh/uv/install.sh | sh
73+
echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
74+
75+
- name: Install ruff
76+
run: uv pip install --system ruff
1677

17-
- name: Run pre-commit
18-
uses: pre-commit/action@v3.0.1
78+
- name: Run ruff linter
79+
run: ruff check .
80+
81+
- name: Run ruff formatter
82+
run: ruff format --check .
83+
84+
test-python:
85+
name: 🐍 Test Python code
86+
runs-on: ubuntu-latest
87+
timeout-minutes: 10
88+
strategy:
89+
matrix:
90+
python-version: ["3.12", "3.13"]
1991

20-
pytest-in-venv:
21-
name: Python tests
22-
runs-on: macos-latest
2392
env:
24-
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
25-
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
93+
# Skip live tests that require API keys in CI
94+
SKIP_LIVE_TESTS: 1
95+
96+
steps:
97+
- name: Checkout Code
98+
uses: actions/checkout@v5
99+
100+
- name: Setup Python ${{ matrix.python-version }}
101+
uses: actions/setup-python@v5
102+
with:
103+
python-version: ${{ matrix.python-version }}
104+
105+
- name: Cache uv dependencies
106+
uses: actions/cache@v4
107+
with:
108+
path: ~/.cache/uv
109+
key: ${{ runner.os }}-uv-py${{ matrix.python-version }}-${{ hashFiles('requirements/requirements-test.txt') }}
110+
restore-keys: |
111+
${{ runner.os }}-uv-py${{ matrix.python-version }}-
112+
113+
- name: Install uv (Rust-powered Python package manager)
114+
run: |
115+
curl -LsSf https://astral.sh/uv/install.sh | sh
116+
echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
117+
118+
- name: Install dependencies with uv
119+
run: |
120+
uv pip install --system -r requirements/requirements-test.txt
121+
uv pip install --system -e .
122+
123+
- name: Run the tests with coverage
124+
run: pytest -n auto --cov=aicodebot --cov-report=xml --cov-report=term-missing
125+
126+
- name: Upload coverage to Codecov
127+
if: matrix.python-version == '3.13'
128+
uses: codecov/codecov-action@v5
129+
with:
130+
files: ./coverage.xml
131+
fail_ci_if_error: false
132+
133+
build-package:
134+
name: 🏗️ Build Python package
135+
runs-on: ubuntu-latest
26136
timeout-minutes: 5
137+
needs: [lint-code, test-python]
27138

28139
steps:
29140
- name: Checkout Code
30-
uses: actions/checkout@v4
141+
uses: actions/checkout@v5
31142

32143
- name: Setup Python
33144
uses: actions/setup-python@v5
34145
with:
35-
python-version: "3.11"
36-
cache: pip
146+
python-version: "3.13"
37147

38-
- name: Install dependencies
39-
run: pip install -r requirements/requirements-test.txt
148+
- name: Install build dependencies
149+
run: |
150+
python -m pip install --upgrade pip
151+
pip install build twine
40152
41-
- name: Run configure to create the config file
42-
run: python -m aicodebot.cli configure
153+
- name: Build package
154+
run: python -m build
43155

44-
- name: Run the tests with coverage
45-
# We use record-mode=new_episodes to record new API responses, because some times the open ai
46-
# API calls a different host
47-
run: pytest --cov=./ --cov-report=xml --record-mode=new_episodes
156+
- name: Check package
157+
run: twine check dist/*
48158

49-
- name: Upload coverage reports to Codecov
50-
uses: codecov/codecov-action@v4
159+
- name: Upload build artifacts
160+
uses: actions/upload-artifact@v4
161+
with:
162+
name: dist
163+
path: dist/
164+
165+
publish-package:
166+
name: 🚀 Publish to PyPI
167+
if: |
168+
github.event_name == 'push' &&
169+
startsWith(github.ref, 'refs/tags/v') &&
170+
!contains(github.event.head_commit.message, '[skip-deploy]')
171+
needs: [lint-code, test-python, build-package]
172+
runs-on: ubuntu-latest
173+
timeout-minutes: 5
174+
permissions:
175+
id-token: write # For trusted publishing to PyPI
176+
177+
steps:
178+
- name: Download build artifacts
179+
uses: actions/download-artifact@v4
180+
with:
181+
name: dist
182+
path: dist/
183+
184+
- name: Publish to PyPI
185+
uses: pypa/gh-action-pypi-publish@release/v1
186+
with:
187+
print-hash: true

0 commit comments

Comments
 (0)