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

PLT-1360 - Configure Pronto/Simplecov code coverage in rlovelett-ffmpeg #22

Closed
wants to merge 92 commits into from

Conversation

spaetzel
Copy link

@spaetzel spaetzel commented Feb 9, 2024

First implementation of Pronto code coverage, adding to rlovelett-ffmpeg first since it's open source and could be cloned outside the org for quick iteration.

Action now adds inline PR comments for both Code coverage and Rubocop problems.

Screenshot 2024-02-08 at 9 28 21 PM

Github Copilot Description

This pull request primarily focuses on enhancing the continuous integration (CI) pipeline and improving code quality checks. The changes include updating the GitHub Actions workflow to trigger on both push and pull request events, adding permissions to the GitHub Actions workflow, updating the actions used in the workflow, and adding new dependencies to the Gemfile. Additionally, the SimpleCov and Undercover gems have been added for better code coverage tracking.

GitHub Actions workflow updates:

  • .github/workflows/ci.yaml: The workflow now triggers on both push and pull request events, and additional permissions have been added for the GitHub Actions workflow. The actions used in the workflow have been updated to their latest versions, and additional dependencies have been added to the installation step. A new step has been added to setup and run Pronto for code quality checks during pull request events.

Dependency additions:

  • Gemfile: New dependencies have been added to the Gemfile, including the RuboCop Performance and RuboCop Rake gems for enhanced code quality checks, the Faraday Retry gem for retrying network requests, and the Pronto and Pronto RuboCop gems for running code quality checks. The Undercover gem has been added for tracking untested code sections, and the Rugged, SimpleCov, and SimpleCov-Lcov gems have been added to the test group for better code coverage tracking.

Code coverage tracking:

  • spec/spec_helper.rb: The SimpleCov and SimpleCov-Lcov gems have been required and configured for code coverage tracking. The Undercover gem has also been required for tracking untested code sections.

Will Spaetzel and others added 30 commits January 29, 2024 11:21
Introduced the 'coveralls_reborn' gem to the project and set it up within the test suite to track test coverage.

Updated the README to include the Coveralls coverage status badge, ensuring visibility into the project's code coverage metrics. This change assists in maintaining and improving code quality.

# Please note any issue or ticket numbers related to this change if applicable.
Add Coveralls Integration
Add autogenerated code for lcov
@spaetzel spaetzel requested review from Kyrluckechuck and a team as code owners February 9, 2024 15:44
@spaetzel spaetzel requested review from todd-m-kemp and JoshGalantai-Vidyard and removed request for a team February 9, 2024 15:44
Copy link

@Kyrluckechuck Kyrluckechuck left a comment

Choose a reason for hiding this comment

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

Not requesting any changes for now, but want to see the output / result before approving! 😛

- name: Install Deps
run: |
apt update && apt install cmake -y

Choose a reason for hiding this comment

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

Do we need to install cmake for rubocop to run? 🤔

Copy link
Author

Choose a reason for hiding this comment

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

cmake is for rugged - which is used by Pronto/Undercover to perform git operations

rainbow (>= 2.1, < 4.0)
rugged (>= 0.27, < 1.7)
unicode-display_width (2.5.0)
uri (0.13.0)

PLATFORMS
ruby

DEPENDENCIES

Choose a reason for hiding this comment

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

Oof, that's a lot of new deps just for code coverage 😰

@spaetzel
Copy link
Author

spaetzel commented Feb 9, 2024

Need to turn on read & write permissions for actions in the repo. Asked @masterful to flip this on

todd-m-kemp
todd-m-kemp previously approved these changes Feb 9, 2024
@spaetzel spaetzel requested a review from masterful February 9, 2024 16:31
Will Spaetzel and others added 2 commits February 9, 2024 11:33
@spaetzel spaetzel closed this Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants