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

(maint) - Make codecov gem support optional - changes to spec:simplecov rake task #424

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

jordanbreen28
Copy link
Contributor

@jordanbreen28 jordanbreen28 commented Jan 16, 2024

Summary

The codecov gem has been deprecated and unsupported for quite some time now. (2+ years).
This means we are restricted to outdated versions < 0.22 of simplecov which include bugs with ruby 3.2, and naturally wont be receiving further updates. (See here)

We should update the module_spec_helper file to only include this gem if installed by the user, else update documentation to guide users in how to now upload the coverage reports to codecov.io.

Additional Context

See codecov repo https://github.com/codecov/codecov-ruby

Related Issues (if any)

Mention any related issues or pull requests.

Checklist

  • 🟢 Spec tests.
  • 🟢 Acceptance tests.
  • Manually verified.

@jordanbreen28 jordanbreen28 changed the title (maint) - remove deprecated codecov gem (maint) - remove deprecated codecov gem - changes to spec:simplecov rake_task Jan 16, 2024
@jordanbreen28 jordanbreen28 marked this pull request as ready for review January 16, 2024 15:09
@codecov-commenter
Copy link

codecov-commenter commented Jan 16, 2024

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (4e9eff6) 41.90% compared to head (89c244c) 41.71%.

Files Patch % Lines
lib/puppetlabs_spec_helper/module_spec_helper.rb 0.00% 18 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #424      +/-   ##
==========================================
- Coverage   41.90%   41.71%   -0.19%     
==========================================
  Files          10       10              
  Lines         673      676       +3     
==========================================
  Hits          282      282              
- Misses        391      394       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jordanbreen28 jordanbreen28 force-pushed the maint-remove_deprecated_codecov_gem branch 2 times, most recently from d3ce31b to ee6d8f7 Compare January 16, 2024 17:20
@jordanbreen28 jordanbreen28 changed the title (maint) - remove deprecated codecov gem - changes to spec:simplecov rake_task (maint) - Add codecov gem optional support - changes to spec:simplcov rake task Jan 19, 2024
@jordanbreen28 jordanbreen28 marked this pull request as ready for review January 19, 2024 09:09
@jordanbreen28 jordanbreen28 force-pushed the maint-remove_deprecated_codecov_gem branch from ee6d8f7 to 765fab0 Compare January 19, 2024 09:09
@ekohl
Copy link
Contributor

ekohl commented Jan 19, 2024

Slight nit: I'd rephrase the title as "Make codecov support optional" instead of "Add". Add implies it wasn't there before, but it was. Also, there's a typo in spec:simplecov.

@jordanbreen28 jordanbreen28 changed the title (maint) - Add codecov gem optional support - changes to spec:simplcov rake task (maint) - Make codecov gem support optional - changes to spec:simplecov rake task Jan 19, 2024
@jordanbreen28
Copy link
Contributor Author

ah! derp. @ekohl Thanks for all your help on this one!

The codecov gem is deprecated, thus we should try to avoid its use if
possible. We still allow users to require and use this gem if installed
in their environments.
@jordanbreen28 jordanbreen28 force-pushed the maint-remove_deprecated_codecov_gem branch from 765fab0 to 89c244c Compare January 19, 2024 15:02
Copy link
Contributor

@LukasAud LukasAud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@LukasAud LukasAud merged commit 27b547e into main Jan 22, 2024
6 checks passed
@LukasAud LukasAud deleted the maint-remove_deprecated_codecov_gem branch January 22, 2024 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants