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

coverage.json being uploaded to GitHub #50

Open
PCain02 opened this issue Nov 14, 2024 · 3 comments
Open

coverage.json being uploaded to GitHub #50

PCain02 opened this issue Nov 14, 2024 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@PCain02
Copy link
Collaborator

PCain02 commented Nov 14, 2024

Describe the bug
The bug is that we currently don't ignore the coverage.json file so it is getting uploaded to GitHub where it is large.

To Reproduce
Steps to reproduce the behavior:

  1. poetry run task coverage
  2. git add
  3. `git commit '
  4. git push
  5. look at GitHub

Expected behavior
We should not have the coverage.json file on GitHub because it is large. Our badges should not rely on the coverage.json file

Desktop (please complete the following information):
ALL OS

@PCain02 PCain02 added the bug Something isn't working label Nov 14, 2024
@PCain02
Copy link
Collaborator Author

PCain02 commented Nov 21, 2024

@gkapfham Do we have a plan for coverage going forward or do we need to discuss this as a class?

@gkapfham
Copy link
Collaborator

coverage.json file cannot be commited to the repository. Please note that I have removed it from an active PR that I am working on. This step then results in the following message in GitHub Actions:

Run poetry run python scripts/badges.py
  poetry run python scripts/badges.py
  shell: /usr/bin/bash -e {0}
  env:
    COLUMNS: 1[2](https://github.com/GatorEducator/execexam/actions/runs/11959763261/job/33342265041?pr=54#step:10:2)0
    PYTHONIOENCODING: utf8
    pythonLocation: /opt/hostedtoolcache/Python/[3](https://github.com/GatorEducator/execexam/actions/runs/11959763261/job/33342265041?pr=54#step:10:3).12.7/x64
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.12.7/x6[4](https://github.com/GatorEducator/execexam/actions/runs/11959763261/job/33342265041?pr=54#step:10:4)/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.7/x[6](https://github.com/GatorEducator/execexam/actions/runs/11959763261/job/33342265041?pr=54#step:10:6)4
    Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.[7](https://github.com/GatorEducator/execexam/actions/runs/11959763261/job/33342265041?pr=54#step:10:7)/x64
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.7/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.12.7/x64/lib
Error: /home/runner/work/execexam/execexam/scripts/../coverage.json not found.

This is not breaking the build. However, it is showing that coverage is no longer updating correctly.

With that said, it is critical to point out that the coverage.json file is a derived file and we cannot include it inside of the GitHub repository.

@boulais01
Copy link
Collaborator

Will this be fixed by PR #60, since that states it will remove coverage.json? @Chezka109 can you comment on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants