ci: Add GitHub Actions CI/CD workflows

[mikejmorgan-ai]

Summary

• Add CI workflow with lint (ruff), typecheck (mypy), test (pytest) across Python 3.10-3.12
• Add release workflow for PyPI publishing on version tags
• Add Codecov integration for coverage reporting
• Add status badges to README

Workflows Added

• .github/workflows/ci.yml - Runs on push/PR to main
• .github/workflows/release.yml - Triggers on v* tags

Test Plan

• CI workflow runs successfully on this PR
• Badges display correctly in README

Summary by CodeRabbit

Release Notes

• Chores

  • Implemented automated testing and quality checks pipeline including linting and type checking across Python 3.10, 3.11, and 3.12
  • Enabled automated package publishing workflow for releases
  • Integrated code coverage tracking and reporting

• Documentation

  • Added status badges to README for CI pipeline, package version, Python compatibility, license, and code coverage

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The PR introduces two new GitHub Actions workflows to automate CI/CD processes and adds status badges to the README. The CI workflow runs linting, type-checking, tests across Python 3.10-3.12, and package builds with coverage reporting. The release workflow automates package publication to PyPI and GitHub release creation on version tags.

Changes

Cohort / File(s)	Summary
GitHub Actions CI/CD Workflows .github/workflows/ci.yml, .github/workflows/release.yml	Added CI workflow with lint, typecheck, test (Python 3.10, 3.11, 3.12 matrix), and build jobs with Codecov integration. Added release workflow triggering on version tags (v\*) to build, publish to PyPI, and create GitHub releases with version extraction from tags.
Documentation Badges README.md	Added status badges for CI, PyPI, Python versions, Apache-2.0 license, and Codecov at the top of the file.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 Workflows hop into place, so neat and clean,
CI checks the code from lint to test serene,
PyPI awaits the build with open paws,
Badges bloom in README without pause,
Automation thrives—our infrastructure cheers! 🚀

---

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between a10f810 and ce2671f.

📒 Files selected for processing (3)

• .github/workflows/ci.yml
• .github/workflows/release.yml
• README.md

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @mikejmorgan-ai, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's development lifecycle by introducing robust CI/CD pipelines via GitHub Actions. It automates critical quality checks like linting, type checking, and testing across multiple Python versions, streamlines the release process to PyPI, and integrates code coverage reporting. These changes aim to improve code quality, accelerate development, and provide clear project status indicators.

Highlights

• Continuous Integration (CI) Workflow: A new CI workflow has been added using GitHub Actions to automatically run linting (ruff), type checking (mypy), and tests (pytest) across Python versions 3.10, 3.11, and 3.12 on every push and pull request to the main branch.
• Continuous Delivery (CD) Release Workflow: A release workflow has been implemented to automate publishing to PyPI when version tags (e.g., v1.0.0) are pushed to the repository.
• Code Coverage Integration: Codecov integration has been set up to provide detailed code coverage reporting, ensuring better visibility into test coverage.
• README Badges: Status badges for CI, PyPI version, supported Python versions, license, and Codecov coverage have been added to the README.md file for quick status visibility.

Ignored Files

• Ignored by pattern: .github/workflows/** (2)
  • .github/workflows/ci.yml
  • .github/workflows/release.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces CI/CD workflows using GitHub Actions and adds corresponding status badges to the README.md. The changes to the README look good, but I've noted an inconsistency with the license information. The new license badge correctly shows Apache-2.0, aligning with pyproject.toml, but the license section at the end of the README still mentions MIT. This should be corrected for consistency.

Additionally, I noticed a discrepancy between the PR description, which mentions testing on Python 3.10-3.12, and pyproject.toml, which specifies requires-python = ">=3.11". It would be good to align the CI matrix with the project's stated Python version support.

[gemini-code-assist]

There is a license inconsistency. This badge indicates an Apache-2.0 license, which matches pyproject.toml. However, the License section at the bottom of this README (line 168) specifies 'MIT License'. Please update the License section to 'Apache-2.0' to ensure consistency across the project.