Skip to content

[RFC]: Setup automation for cleaning up obsolete test coverage reports #10

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

Closed
Planeshifter opened this issue Feb 13, 2025 · 1 comment · Fixed by stdlib-js/www-test-code-coverage#5
Assignees
Labels
difficulty: 2 May require some initial design or R&D, but should be straightforward to resolve and/or implement. estimate: 4-8hrs Task which should take between 4 to 8 hours. Feature Task to add a new feature. ❌ No AI Not allowed to use AI.

Comments

@Planeshifter
Copy link
Member

Planeshifter commented Feb 13, 2025

Task is to implement an automated cleanup process for test coverage reports to handle deleted, renamed, or deprecated packages and files.

We can implement a weekly automated GitHub actions workflow in the test coverage repository that:

  • Retrieves the current state from the main repository:

    • List of all packages
    • Files inside each package (EDIT: Files are not independently represented in the coverage repo; if a file has changed the updated coverage report in the coverage repo will already omit. For this workflow, we thus will only need to look at package directories)

We can compare this against the coverage repository state to identify:

  • Deleted/renamed packages
  • Deleted/renamed files within packages

If any files should be removed, the workflow should create a Pull Request that removes the outdated coverage data.

Time estimate without AI: 4h.
Time estimate with AI: 3h.

@kgryte kgryte added Enhancement Task to enhance existing functionality. difficulty: 2 May require some initial design or R&D, but should be straightforward to resolve and/or implement. Feature Task to add a new feature. estimate: 4-8hrs Task which should take between 4 to 8 hours. and removed Enhancement Task to enhance existing functionality. labels Feb 14, 2025
@kgryte kgryte changed the title [FEATURE]: Automated Test Coverage Cleanup Process [RFC]: Setup automation for cleaning up obsolete test coverage reports Feb 14, 2025
@naterush naterush added 🤖 AI Allowed to use AI. ❌ No AI Not allowed to use AI. and removed 🤖 AI Allowed to use AI. labels Feb 17, 2025
@naterush naterush added 🤖 AI Allowed to use AI. ❌ No AI Not allowed to use AI. and removed ❌ No AI Not allowed to use AI. 🤖 AI Allowed to use AI. labels Feb 25, 2025
@naterush naterush added the ❌ No AI Not allowed to use AI. label Mar 7, 2025
@Planeshifter
Copy link
Member Author

PR-URL: stdlib-js/www-test-code-coverage#5

Loom recordings:

https://www.loom.com/share/fa1d69bd2ab84489998bb531da33e9c3?sid=61ff77ec-18f8-4a53-bd19-d065602b9317
https://www.loom.com/share/1664fbd56fd641d6801b5b062b807fae?sid=36107f6e-63f3-4177-ae4b-84bcfd6f8ca9
https://www.loom.com/share/1664fbd56fd641d6801b5b062b807fae?sid=788c7a21-73f2-4a42-bb3c-994d5900c5b0

Time to completion: 1h 49min

Notes: After considering various approaches for how to accomplish this and where this workflow should live, I decided to go with a simple Bash script and have it be placed in the coverage repository at https://github.com/stdlib-js/www-test-code-coverage. AI completion certainly would have helped me during the process of writing the needed code. My initial time estimate for this task was likely overly conservative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: 2 May require some initial design or R&D, but should be straightforward to resolve and/or implement. estimate: 4-8hrs Task which should take between 4 to 8 hours. Feature Task to add a new feature. ❌ No AI Not allowed to use AI.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants