Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant improvements to project infrastructure, automation, and documentation. It adds comprehensive GitHub Actions workflows for testing, releasing, and documentation deployment, provides a detailed contributing guide, modernizes the Docker build process, and updates licensing information. These changes streamline CI/CD, clarify contribution standards, and improve maintainability.
Continuous Integration and Deployment:
.github/workflows/test.ymlfor automated testing and coverage reporting on pull requests and non-main branch pushes, supporting multiple Python versions and uploading coverage to Codecov..github/workflows/release.ymlto automate testing, linting, and Docker image building/publishing on releases, including multi-registry support for Docker Hub and GitHub Container Registry..github/workflows/pages.ymlto automatically build and deploy documentation to GitHub Pages using MkDocs, including steps to generate default documentation files if missing.Documentation and Contribution Guidelines:
CONTRIBUTING.mdoutlining code standards, development setup, testing practices, naming conventions, and PR process to help onboard new contributors and maintain code quality.Build and Packaging:
Dockerfileleveraging Python 3.11, Poetry for dependency management, and exposing the default service port, improving reproducibility and deployment.Pipfilein favor of Poetry, reflecting a shift to more robust dependency management.Licensing:
LICENSEto reflect new copyright ownership under CIRCLE cyber.