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

Add Dashboard information to v0.49.0 release notes #3544

Merged
merged 3 commits into from
Jan 16, 2024

Conversation

oleiade
Copy link
Member

@oleiade oleiade commented Jan 16, 2024

What?

This PR adds a web-dashboard dedicated section to the release notes.

⚠️ Currently the report image is far to big, but we have opened grafana/xk6-dashboard#144 to add a smaller screenshot, and will make sure to replace the current screenshot with that one before merging 👍🏻

@codecov-commenter
Copy link

codecov-commenter commented Jan 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release-v0.49.0@3429402). Click here to learn what that means.

❗ Current head 3a6d0a0 differs from pull request most recent head b3d8f1f. Consider uploading reports for the commit b3d8f1f to get more accurate results

Additional details and impacted files
@@                Coverage Diff                 @@
##             release-v0.49.0    #3544   +/-   ##
==================================================
  Coverage                   ?   73.20%           
==================================================
  Files                      ?      267           
  Lines                      ?    20076           
  Branches                   ?        0           
==================================================
  Hits                       ?    14696           
  Misses                     ?     4466           
  Partials                   ?      914           
Flag Coverage Δ
ubuntu 73.14% <0.00%> (?)
windows 73.03% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

release notes/v0.49.0.md Outdated Show resolved Hide resolved

To access and download the report, click on the `Report` button located in the top right corner of the dashboard.

![HTML Report Generated by k6 Dashboard](https://github.com/grafana/xk6-dashboard/blob/master/screenshot/k6-dashboard-html-report.png?raw=true)
Copy link
Contributor

Choose a reason for hiding this comment

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

TBH, I'm wondering if both images should be embedded. For instance, the second image could remain a link, and customers could open and see a complete example of the report in a separate tab/window.

Copy link
Member Author

Choose a reason for hiding this comment

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

I was wondering the same, I don't think I have a strong take on either way, although I find that this feature is very visual, and giving a visual clue is a good call to action. Maybe we keep the first image and keep the second as link instead?

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we keep the first image and keep the second as link instead?

Yes, that's exactly what I was wondering, too 👍 It's essential to attract the attention of our customers, but I believe if both images are embedded, it could overload attention.

So 👍 for keeping the first image as it is and moving the second to a link, something like an example of the report you could find here or a better sugegstion

Copy link
Member Author

Choose a reason for hiding this comment

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

Perfect wilco 👍🏻

@oleiade oleiade merged commit 8ec3e77 into release-v0.49.0 Jan 16, 2024
21 checks passed
@oleiade oleiade deleted the release-v0.49.0-dashboard branch January 16, 2024 14:42
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