feat: Enhance repository with professional metadata, badges, and CI/CD#3
Merged
Conversation
This commit introduces a comprehensive set of improvements to professionalize the repository. - Updates `pyproject.toml` with rich project metadata, including classifiers, keywords, and project URLs, and configures pytest for coverage reporting. - Enhances `README.md` with a full suite of status badges for PyPI, build status, code coverage, and more. - Implements a new, unified CI/CD workflow in `.github/workflows/ci-cd.yml` that handles linting, testing on multiple Python versions, coverage uploads to Codecov, and automated PyPI publishing on new version tags. - The CI/CD workflow is configured to run on pushes and pull requests to both the `main` and `develop` branches. - Removes the old, redundant CI workflow.
The previous commit SHA for the `codecov/codecov-action` GitHub Action was invalid, causing the CI workflow to fail. This commit updates the SHA to the latest stable version (`v5.5.1`), which resolves the issue.
The Codecov action was failing with a "Repository not found" error. This commit resolves the issue by explicitly providing the repository slug to the `codecov/codecov-action` using the `github.repository` context variable. This ensures that the action can always correctly identify the repository.
To better diagnose the "Repository not found" error, this commit enables verbose logging for the `codecov/codecov-action` in the CI workflow. This will provide more detailed output to help pinpoint the cause of the issue.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
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
1 participant
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 commit introduces a comprehensive set of improvements to professionalize the repository.
pyproject.tomlwith rich project metadata, including classifiers, keywords, and project URLs, and configures pytest for coverage reporting.README.mdwith a full suite of status badges for PyPI, build status, code coverage, and more..github/workflows/ci-cd.ymlthat handles linting, testing on multiple Python versions, coverage uploads to Codecov, and automated PyPI publishing on new version tags.mainanddevelopbranches.