CI/CD with GitHub Actions

This guide explains how to automate testing, linting, and deployment for the Py Launch Blueprint project using GitHub Actions. Learn more.

Workflow Overview

The CI/CD workflow (.github/workflows/ci.yaml) runs on:

• Pushes to main

• Pull requests targeting main

Jobs

• Test: Runs tests on Python 3.10 and 3.11

  • Sets up environment using uv and actions/setup-python

  • Installs dependencies: uv sync --all-extras --dev

  • Runs MyPy (uvx mypy), Ruff (uvx ruff check), and pytest (uvx pytest)

Workflow Configuration

name: CI/CD

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10", "3.11"]

    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v5
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - run: uv sync --all-extras --dev
      - run: uvx mypy py_launch_blueprint/
      - run: uvx ruff check py_launch_blueprint/
      - run: uvx pytest

Customization

• Add more Python versions:

  strategy:
    matrix:
      python-version: ["3.10", "3.11", "3.12"]
  

• Add security scanning:

  - name: Run security scan
    run: uvx bandit -r py_launch_blueprint/
  

• Cache dependencies:

  - uses: actions/cache@v3
    with:
      path: .venv
      key: venv-${{ runner.os }}-${{ hashFiles('**/pyproject.toml') }}