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

ci: Resolve SonarCloud warnings #7119

Merged
merged 1 commit into from
Sep 4, 2023
Merged

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Sep 4, 2023

Development & PR Process

  1. Follow MetaMask Mobile Coding Standards
  2. Add release-xx label to identify the PR slated for a upcoming release (will be used in release discussion)
  3. Add needs-dev-review label when work is completed
  4. Add the appropiate QA label when dev review is completed
    • needs-qa: PR requires manual QA.
    • No QA/E2E only: PR does not require any manual QA effort. Prior to merging, ensure that you have successful end-to-end test runs in Bitrise.
    • Spot check on release build: PR does not require feature QA but needs non-automated verification. In the description section, provide test scenarios. Add screenshots, and or recordings of what was tested.
  5. Add QA Passed label when QA has signed off (Only required if the PR was labeled with needs-qa)
  6. Add your team's label, i.e. label starting with team- (or external-contributor label if your not a MetaMask employee)

Description

SonarCloud reports currently have two warnings on them: one about not being able to find main, the other about detecting a shallow clone. These are both caused by the same problem: the GitHub Action workflow that runs SonarCloud is doing a shallow clone of just the pull request branch.

This workflow has been updated to perform a full checkout, including git history for all branches. This should provide the SonarCloud action with all of the information it needs to analyze the pull request, resolving both of these warnings.

The Java warning requires an update to the SonarCloud GitHub Action, which requires a change to our organization policy, so that will have to wait for a future PR.

Screenshots/Recordings

Before:

Screenshot from 2023-09-04 09-58-16

After:

Screenshot from 2023-09-04 11-19-36

Issue

No related issue

Checklist

  • There is a related GitHub issue
  • Tests are included if applicable
  • Any added code is fully documented

@codecov-commenter
Copy link

codecov-commenter commented Sep 4, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (02e4ed6) 32.84% compared to head (f09a8c1) 32.84%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7119   +/-   ##
=======================================
  Coverage   32.84%   32.84%           
=======================================
  Files        1001     1001           
  Lines       26780    26780           
  Branches     2118     2118           
=======================================
  Hits         8797     8797           
  Misses      17559    17559           
  Partials      424      424           

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

@Gudahtt Gudahtt force-pushed the resolve-sonarcloud-warnings branch 2 times, most recently from f546274 to fd19492 Compare September 4, 2023 13:30
SonarCloud reports currently have two warnings on them: one about not
being able to find `main`, the other about detecting a shallow clone.
These are both caused by the same problem: the GitHub Action workflow
that runs SonarCloud is doing a shallow clone of just the pull request
branch.

This workflow has been updated to perform a full checkout, including
git history for all branches. This should provide the SonarCloud action
with all of the information it needs to analyze the pull request,
resolving both of these warnings.
@Gudahtt Gudahtt marked this pull request as ready for review September 4, 2023 13:50
@Gudahtt Gudahtt requested a review from a team as a code owner September 4, 2023 13:50
@sonarcloud
Copy link

sonarcloud bot commented Sep 4, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

warning The version of Java (11.0.20) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17.
Read more here

@Gudahtt Gudahtt added needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) No QA Needed/E2E Only Apply this label when your PR does not need any QA effort. labels Sep 4, 2023
Copy link
Contributor

@NicolasMassart NicolasMassart left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@Gudahtt Gudahtt removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Sep 4, 2023
@Gudahtt Gudahtt merged commit 0c81a66 into main Sep 4, 2023
19 checks passed
@Gudahtt Gudahtt deleted the resolve-sonarcloud-warnings branch September 4, 2023 16:21
@github-actions github-actions bot locked and limited conversation to collaborators Sep 4, 2023
@metamaskbot metamaskbot added the release-7.8.0 Issue or pull request that will be included in release 7.8.0 label Sep 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
No QA Needed/E2E Only Apply this label when your PR does not need any QA effort. release-7.8.0 Issue or pull request that will be included in release 7.8.0 team-extension-platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants