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.

Sign up for GitHub

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

Jump to bottom

Codecov badge should reflect test coverage of currently used git branch [FR] #1086

Open
ilyaZar opened this issue Aug 9, 2023 · 0 comments
Open

Codecov badge should reflect test coverage of currently used git branch [FR] #1086

ilyaZar opened this issue Aug 9, 2023 · 0 comments
Labels
enhancement New feature or request PR opened 👓 WIP 🏃‍♀️

Comments

@ilyaZar
Copy link
Contributor

ilyaZar commented Aug 9, 2023 •
edited

Is your feature request related to a problem?

The coverage status badge always reports code coverage for the master branch (as the links are hard-coded) even when switching to a different branch such as dev.

This may be misleading and makes it difficult to (quickly) see the testing coverage when implementing new features to e.g. dev-branch.

Describe the solution you'd like
Change the badge links (webpage-link + svg-image-link) inside README.Rmd to the currently used branch (for all branches of {golem}).

Describe alternatives you've considered

  • one could scroll down to the "About" section on the README page and see the output of covr::package_coverage() but it takes more time; a badge at the top would make this quicker

Additional context
Can be fixed via #1087
@ilyaZar ilyaZar added the enhancement New feature or request label Aug 9, 2023
ilyaZar added a commit to ilyaZar/golem that referenced this issue Aug 9, 2023
@ilyaZar
feature: use test coverage for current git-branch
b462d88 
- to clearly show what the testing coverage is on each branch via the
  badge
- `README.Rmd` is altered to programatically retrieve the current git
  branch which automatically uses the correct coverage results from https://about.codecov.io/

Refs: ThinkR-open#1086
@ilyaZar ilyaZar mentioned this issue Aug 9, 2023
Merged
ColinFay pushed a commit that referenced this issue Feb 28, 2024
@ilyaZar @ColinFay
feature: use test coverage for current git-branch
f536fe9 
- to clearly show what the testing coverage is on each branch via the
  badge
- `README.Rmd` is altered to programatically retrieve the current git
  branch which automatically uses the correct coverage results from https://about.codecov.io/

Refs: #1086
@ColinFay ColinFay mentioned this issue Feb 28, 2024
Merged
ColinFay pushed a commit that referenced this issue Feb 28, 2024
@ilyaZar @ColinFay
feature: use test coverage for current git-branch
4eaacb2 
- to clearly show what the testing coverage is on each branch via the
  badge
- `README.Rmd` is altered to programatically retrieve the current git
  branch which automatically uses the correct coverage results from https://about.codecov.io/

Refs: #1086
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request PR opened 👓 WIP 🏃‍♀️
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ArthurData @ilyaZar