Skip to content

Update k6 browser docs to align with k6 v0.44.0 release #1131

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Apr 24, 2023
Merged

Update k6 browser docs to align with k6 v0.44.0 release #1131

merged 9 commits into from
Apr 24, 2023

Conversation

mdcruz
Copy link
Contributor

@mdcruz mdcruz commented Apr 14, 2023 •
edited
Loading

Once we release k6 v0.44.0, we need to update k6 browser documentation to reflect the following new changes:

  • Convert locator.click() to use await keyword
  • Document browserContext.addCookies()
  • Document Google Web Vitals

This PR covers the following issues:

#1126
#1127
#1128
#1078

@mdcruz mdcruz requested review from ankur22, ka3de and inancgumus April 14, 2023 19:38
This was linked to issues Apr 14, 2023
Document k6 browserContext.addCookies #1128
Closed
Update browser metrics to reflect web vitals #1127
Closed
Update locator.click() to use async/await syntax #1126
Closed
@github-actions
Copy link
Contributor

There's a version of the docs published here:

https://mdr-ci.staging.k6.io/docs/refs/pull/1131/merge

It will be deleted automatically in 30 days.

@mdcruz mdcruz requested a review from immavalls April 14, 2023 19:53
@mdcruz mdcruz linked an issue Apr 14, 2023 that may be closed by this pull request
Document windows commands explicitly in the browser docs #1078
Closed
@immavalls
Copy link
Contributor

#1078 lgtm @mdcruz

ka3de
ka3de reviewed Apr 17, 2023
View reviewed changes
Copy link
Contributor

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

Awesome @mdcruz ! 👏

Just a couple of comments.
I believe we are missing the BrowserContext.addCookie() entry in the BrowserContext methods table here. Although it is present and reachable from the left sidebar.

Also, should we merge the PRs #1114 and #1091 in this branch to group the doc changes for the v0.44.0 version? Or will we merge them independently?

@mdcruz
Copy link
Contributor Author

mdcruz commented Apr 17, 2023

Awesome @mdcruz ! 👏

Just a couple of comments. I believe we are missing the BrowserContext.addCookie() entry in the BrowserContext methods table here. Although it is present and reachable from the left sidebar.

Also, should we merge the PRs #1114 and #1091 in this branch to group the doc changes for the v0.44.0 version? Or will we merge them independently?

Ah, yes I forgot! I will add it to the table 👍
Merging PRs #1114 and #1091 makes sense to me. Can you help with those, please? Thanks!

@ka3de
Copy link
Contributor

ka3de commented Apr 17, 2023

Merging PRs #1114 and #1091 makes sense to me. Can you help with those, please? Thanks!

Yes, will merge them both here then 👍

ka3de
ka3de approved these changes Apr 17, 2023
View reviewed changes
Copy link
Contributor

@ka3de ka3de 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 approved these changes Apr 17, 2023
View reviewed changes
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 these changes, especially around web vitals 🙌! LGTM!

@mdcruz mdcruz force-pushed the update-k6-browser-docs branch from 517d5a6 to a44d666 Compare April 18, 2023 16:11
@mdcruz mdcruz mentioned this pull request Apr 20, 2023
Merged
@ka3de ka3de force-pushed the update-k6-browser-docs branch from a44d666 to 430148f Compare April 24, 2023 08:24
@ka3de ka3de force-pushed the update-k6-browser-docs branch from 430148f to fa9d976 Compare April 24, 2023 08:49
@ka3de ka3de merged commit 3786f03 into main Apr 24, 2023
@ka3de ka3de deleted the update-k6-browser-docs branch April 24, 2023 08:49
This was referenced Apr 24, 2023
Closed
Closed
@inancgumus inancgumus added the Area: browser The browser module label Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ankur22 ankur22 ankur22 approved these changes

@ka3de ka3de ka3de approved these changes

@inancgumus inancgumus Awaiting requested review from inancgumus

@immavalls immavalls Awaiting requested review from immavalls

Assignees
No one assigned
Labels
Area: browser The browser module
Projects
None yet
Milestone
No milestone
5 participants
@mdcruz @immavalls @ka3de @ankur22 @inancgumus