Skip to content

Add GitHub Actions Workflow Files #17

@jtdub

Description

@jtdub

Problem

The README and CHANGELOG reference CI/CD workflows but no .github/workflows/ directory exists in the repository.

Proposed Solution

Create GitHub Actions workflows for:

1. Test Workflow

  • Run on PRs and pushes to main
  • Test on Python 3.10, 3.11, 3.12, 3.13
  • Upload coverage reports

2. Lint Workflow

  • Run Black, Ruff, Mypy checks

3. Release Workflow

  • Build and publish to PyPI on release

4. Documentation Workflow

  • Build and deploy MkDocs to GitHub Pages

Acceptance Criteria

  • Test workflow runs on PRs and pushes
  • Tests run on all supported Python versions
  • Lint workflow checks Black, Ruff, Mypy
  • Release workflow publishes to PyPI
  • Documentation workflow deploys to GitHub Pages
  • All badges in README work correctly

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions