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

V2 #59

Merged
merged 7 commits into from
Jul 9, 2024
Merged

V2 #59

merged 7 commits into from
Jul 9, 2024

Conversation

Kydoimos97
Copy link
Contributor

No description provided.

This commit introduces pytest code coverage for better insights into test execution. This is accomplished through the use of 'coverage' and 'pytest-cov' tools. Moreover, Sphinx documentation generation and the GitHub Pages deployment steps were removed from the workflow.
Added a title, a centered WrenchCL logo, some relevant badges, and a short description about the WrenchCL library to the documentation home page. This should provide visitors a quick overview of the project.
In this commit, the 'test_tools.py' file has been refactored to enhance readability by separating import statements. Moreover, the CI/CD workflow on GitHub Actions has been improved to handle pull requests on branch 'v2'. It now runs tests in
Added lines of code in the GitHub workflow .yml file to create a 'coverage' directory and move the lcov.info file into this directory before uploading the coverage report. This will help organize the generated test coverage reports better.
The pytest command in the GitHub workflow file, "publish-to-pypi.yml", has been simplified. Extra reports generation like xml and html has been removed, focusing only on lcov coverage reports. Additionally, the creation of the coverage directory and the move of lcov.info file operations have been removed, as they're not necessary.
The commit eliminates the step of posting a coverage report in the GitHub Actions workflow for publishing to Pypi. This was done to streamline the workflow and avoid clutter of coverage reports in pull request comments.
A link to the project documentation on Read the Docs was added to the README file. This will make it easier for users to get detailed information and instructions about the project.
@Kydoimos97 Kydoimos97 merged commit beadc9c into release Jul 9, 2024
1 check passed
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.

None yet

1 participant