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 browser's page.on('console') to release notes #3353

Merged
merged 5 commits into from
Sep 27, 2023

Conversation

ka3de
Copy link
Contributor

@ka3de ka3de commented Sep 26, 2023

What?

Adds an entry for browser module's page.on('console') feature to v0.47.0 release notes.

Why?

page.on('console') method is a new feature for the browser module's API that should be announced in the upcoming k6 release.

Checklist

  • I have performed a self-review of my code.
  • I have added tests for my changes.
  • I have run linter locally (make ci-like-lint) and all checks pass.
  • I have run tests locally (make tests) and all tests pass.
  • I have commented on my code, particularly in hard-to-understand areas.

Related PR(s)/Issue(s)

@ka3de ka3de self-assigned this Sep 26, 2023
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.

Thanks for starting the release notes 👍 I've left a couple of suggestions, one of which will help me understand our style a bit more on naming.

release notes/v0.47.0.md Outdated Show resolved Hide resolved
release notes/v0.47.0.md Outdated Show resolved Hide resolved
Copy link
Member

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

Thanks 👍 WDYT about linking to the k6 docs (like this one)? So, we can tell users they can see an example there.

@codecov-commenter
Copy link

codecov-commenter commented Sep 26, 2023

Codecov Report

All modified lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release-notes-v0.47.0@547de60). Click here to learn what that means.

❗ Current head cec1e31 differs from pull request most recent head 839515a. Consider uploading reports for the commit 839515a to get more accurate results

Additional details and impacted files
@@                   Coverage Diff                    @@
##             release-notes-v0.47.0    #3353   +/-   ##
========================================================
  Coverage                         ?   72.96%           
========================================================
  Files                            ?      261           
  Lines                            ?    20018           
  Branches                         ?        0           
========================================================
  Hits                             ?    14607           
  Misses                           ?     4484           
  Partials                         ?      927           
Flag Coverage Δ
ubuntu 72.90% <0.00%> (?)
windows 72.80% <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.

Renames it in order to replace the xk6-browser references to use the
format browser#PR instead.
@ka3de
Copy link
Contributor Author

ka3de commented Sep 27, 2023

Thanks 👍 WDYT about linking to the k6 docs (like #3352)? So, we can tell users they can see an example there.

I'm always doubtful on linking to documentation in the release notes. In this case, what do you think about adding this sentence to the end of the current description (see the bold italic part):

Allows users to register a handler to be executed every time the console API methods are called from within the page's JavaScript context. The arguments passed into the handler are defined by the (ConsoleMessage)[https://k6.io/docs/javascript-api/k6-experimental/browser/consolemessage/] class.

We can also link the page.on method docs to some point in the sentence, but I see that less clear, and it's easier for users to go check that by themselves as we are announcing the method here.

@inancgumus
Copy link
Member

LGTM. Can you help me understand why you're always doubtful referring to the documentation?

@ka3de
Copy link
Contributor Author

ka3de commented Sep 27, 2023

LGTM. Can you help me understand why you're always doubtful referring to the documentation?

Nevermind, just that it's "confusing" to link docs that are not released yet, but in this case they will be released pretty much at the same time so all good. Changed in 2d9bbb1.

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 🚀

@ankur22 ankur22 mentioned this pull request Sep 27, 2023
5 tasks
@ka3de ka3de merged commit a164603 into release-notes-v0.47.0 Sep 27, 2023
20 checks passed
@ka3de ka3de deleted the update/v0.47-browser-page-on branch September 27, 2023 13:00
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.

4 participants