Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI/CD workflows with tox and GitHub Actions for comprehensive testing, styling, and quality checks #16

Merged
merged 8 commits into from
Jul 24, 2024

Conversation

markurtz
Copy link
Member

Summary

Implements a series of GitHub Actions workflows and tox environments to streamline the CI/CD processes for the project. It replaces the previous Makefile-based pathways and focuses on modernizing the development, testing, and deployment practices.

Details

  • CI/CD Workflows: Introduced multiple GitHub Actions workflows for development, nightly builds, quality checks, and releases.
    • Development Workflow: Runs on pull requests to any branch. Includes unit tests and integration tests for Python versions 3.8 to 3.12.
    • Nightly Workflow: Scheduled to run nightly, ensuring continuous integration health with the unit, integration, and end-to-end tests.
    • Quality Workflow: This runs on pushes to the main branch and pull requests. It ensures code quality with linting, formatting, and type checking.
    • Release Workflow: Triggers on push to release branches, running comprehensive tests to prepare for new releases.
  • tox Configuration: Updated tox.ini to define environments for unit tests, integration tests, end-to-end tests, quality checks, style checks, type checks, build, and clean operations.
  • Developer Documentation: Expanded DEVELOPING.md to guide contributors in setting up the development environment, running tests, and maintaining code quality.
  • README Updates: Updated project documentation to reflect the new CI/CD practices and removed outdated Makefile instructions.

Test Plan

Pending running the new GitHub Actions workflows. If any issues pop up, those will be fixed either in this diff or in subsequent ones.

@markurtz markurtz self-assigned this Jul 23, 2024
parfeniukink
parfeniukink previously approved these changes Jul 23, 2024
markurtz added 5 commits July 23, 2024 10:20
…ox pathways (removal of Makefile pathways) and add supporting github actions files for enablement
…ox pathways (removal of Makefile pathways) and add supporting github actions files for enablement
Copy link
Contributor

@parfeniukink parfeniukink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice ✨

@markurtz markurtz merged commit 051df6b into main Jul 24, 2024
8 checks passed
@markurtz markurtz deleted the github-actions branch July 24, 2024 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants