Skip to content

.github

The .github directory contains the configuration files and automated workflows that drive the project's software development lifecycle. These automated pipelines manage continuous testing, deployment, and even self-documentation of the repository.

The core operational logic of this directory is organized within the workflows subdirectory.

Workflows and CI/CD

The workflows directory houses the GitHub Actions YAML files that build, test, and release the software. All of these workflows leverage Astral's uv for high-performance dependency management and environment setup, targeting Python versions 3.11, 3.12, and 3.13.

Together, these workflows automate three key processes:

  • Continuous Integration (Testing): Triggered on every code push or pull request, the CI suite automatically spins up a matrix of supported Python environments, synchronizes strict dependencies, and executes the entire unit test suite. This guarantees that new changes do not introduce regressions.
  • Package Distribution: Upon the creation of a new GitHub release, this workflow runs the full test matrix to verify stability before using Trusted Publishers (OIDC authentication) to securely build and publish the library directly to PyPI.
  • Self-Documentation Deployment: Also triggered on releases or manual dispatches, this workflow runs a "dogfooding" pipeline. It uses this codebase's own command-line interface (repo-guide) alongside Gemini's LLM API to analyze the repository, generate these documentation guides, compile them with MkDocs, and deploy the updated site to GitHub Pages.