codecov / engineering-team

This is a general repo to use with GH Projects
2 stars 1 forks source link

[Coverage onboarding UI] Show how to generate a coverage report in your CI #1920

Open Adal3n3 opened 1 month ago

Adal3n3 commented 1 month ago

Problem

We have a small percentage of new users who are not familiar with coverage reports. It's important to provide guidance and help them generate a coverage report so they can use the Coverage feature.

On the Test Analytics side: we do show examples on how to generate JUnit XML files before the upload instruction. Screenshot 2024-06-13 at 9 22 00 AM

Describe the solution you'd like

  1. Provide a list of languages we support or at least starts from the most common one -DONE
  2. Be specific on the 3 types of coverage report formats: .xml .json .txt that Codecov supports
  3. The copy and paste code snippets to output a coverage report based on the customer used language and file type.
  4. On the onboarding UI for Coverage Step 1: show how to output/generate a coverage report. Dropdown to select a language and a file type.

Screenshot 2024-07-08 at 10 51 05 AM

Screenshot 2024-06-20 at 11 59 27 AM

Figma: link Notion: link

Adal3n3 commented 1 month ago

Screenshot 2024-07-08 at 11 18 32 AM

Adal3n3 commented 2 weeks ago

@katia-sentry can you assign this issue? Thanks!