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

Release notes: Browser async Tap #3723

Merged
merged 1 commit into from
Apr 29, 2024
Merged

Conversation

inancgumus
Copy link
Member

What?

Add a breaking-change note for the async Tap method.

Why?

The Tap method is converted from sync to async.

Related PR(s)/Issue(s)

Updates: grafana/xk6-browser#1251

@codecov-commenter
Copy link

codecov-commenter commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

❗ Current head 45dc8e0 differs from pull request most recent head 670facb. Consider uploading reports for the commit 670facb to get more accurate results

Additional details and impacted files
@@                Coverage Diff                 @@
##             release-v0.51.0    #3723   +/-   ##
==================================================
  Coverage                   ?   73.52%           
==================================================
  Files                      ?      275           
  Lines                      ?    20242           
  Branches                   ?        0           
==================================================
  Hits                       ?    14882           
  Misses                     ?     4406           
  Partials                   ?      954           
Flag Coverage Δ
macos 73.49% <ø> (?)
ubuntu 73.51% <ø> (?)

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.

Comment on lines +19 to +42
- [`frame.tap`](https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/browser/frame/)
- [`elementHandle.tap`](https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/browser/elementhandle/)
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'll update these links once I update the documentation. I'm doing my best, but let's be ready (and merge this release notes PR first) since k6 wants to release this week.

Copy link
Contributor

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

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

This looks good. Either I can or if you don't mind doing it, could the Browser APIs to Async be amended to mention this breaking change?

Something like "We have migrated a single API (tap), which you can find below that will help visualize the upcoming breaking change"

@inancgumus
Copy link
Member Author

inancgumus commented Apr 29, 2024

Either I can or if you don't mind doing it, could the Browser APIs to Async be amended to mention this breaking change?

Something like "We have migrated a single API (tap), which you can find below that will help visualize the upcoming breaking change

Good idea! What do you think about this? fe1bf87

Update:
Ah, you mean, first putting the notice and then the breaking Tap change.

Update:
Like this?

release notes/v0.51.0.md Outdated Show resolved Hide resolved
release notes/v0.51.0.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

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

LGTM

@inancgumus inancgumus merged commit 1c2296b into release-v0.51.0 Apr 29, 2024
15 of 21 checks passed
@inancgumus inancgumus deleted the browser/async-tap branch April 29, 2024 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants