test coverage badge Feature/test pytest coverage #97
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
- Added pytest coverage reporting to the GitHub Actions workflow, including output to a text file and JUnit XML. - Updated README.md to include a placeholder for pytest coverage comments, which will be dynamically populated by the workflow. - Integrated a step to commit changes to README.md after coverage updates, ensuring documentation stays current.
… step - Corrected the indentation for the "Update README" step in the lint-and-test workflow to ensure proper execution. - This change enhances the clarity and functionality of the workflow, maintaining accurate coverage reporting in the README.md.
…erage - Adjusted the path for pytest coverage output in the GitHub Actions workflow to ensure correct file location. - Added pytest coverage output files to .gitignore to prevent unnecessary tracking in the repository.
- Removed unnecessary line from README.md. - Adjusted paths for pytest coverage output and JUnit XML in the GitHub Actions workflow to reflect the correct directory structure.
- Replaced the manual README update step with the pytest-coverage-comment action for automated coverage reporting. - Streamlined the workflow by removing unnecessary commit steps, enhancing efficiency in coverage updates.
- Adjusted paths for pytest coverage output and JUnit XML to reflect the correct directory structure. - Added a step to update the README.md with the latest coverage information and commit the changes automatically.
- Introduced an ID for the pytest coverage comment step to facilitate future reference and enhancements in the workflow. - This change improves the clarity and maintainability of the GitHub Actions configuration.
- Added placeholders for pytest coverage comments in both README.md and backend/README.md. - Adjusted the GitHub Actions workflow to update the backend README with the latest coverage information, ensuring accurate documentation.
- Updated the pytest command to generate an XML coverage report, improving the coverage data output. - Modified the coverage comment step to reference the new XML coverage report, ensuring accurate integration with the coverage comment action.
…workflow" This reverts commit 054c08b.
- Simplified the pytest command in the workflow by removing the `cd` command and using the `working-directory` attribute. - Enhanced readability of the pytest command by formatting it across multiple lines, improving maintainability.
…kflow - Changed the file pattern from README.md to backend/README.md to ensure the correct README is updated with the latest coverage information.
- Introduced a coverage path prefix for the pytest coverage report to ensure accurate path resolution in the generated reports.
- Updated the coverage path prefix to include a trailing slash for accurate path resolution in the pytest coverage report.
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.
🎉 Merge Request Summary – Improve CI, Coverage & Dev Tools
🚀 Overview
This MR introduces significant improvements to the CI pipeline, test coverage automation, and development tooling.
It adds automatic coverage reporting, cleans up configuration files, and enhances the local development experience.
🧩 Key Changes
🧪 CI & Test Coverage
.github/workflows/lint-and-test.yaml:working-directoryto simplify test execution 🧭pytest.xml,pytest-coverage.txt) 📊MishaKav/pytest-coverage-commentGitHub Action to auto-post coverage reports 💬cd backendstep🧹 Repository Maintenance
.gitignore:pytest-coverage.txt,pytest.xml) 🧾🧰 VS Code & Dev Configs
.vscode/launch.jsonand.vscode/settings.json→ now executable (755) ⚙️🧑💻 Backend Updates
.flake8→ linter rules tuned for backend consistency 🧼backend/pyproject.toml→ dependency & tool updatesbackend/generate_password_hash.py→ new or refactored password utility 🔐backend/yet_another_calendar/log.py→ improved logging structure and format 🪵backend/README.mdto include placeholders for dynamic coverage comment 📝📊 Stats
✅ Why It Matters
🌟 Summary
This MR brings the project’s developer workflow to the next level 🚀 —
making testing, coverage, and automation smoother and more maintainable across environments.