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 CPU and Network throttling to release notes #3453

Merged
merged 2 commits into from
Nov 21, 2023

Conversation

ankur22
Copy link
Contributor

@ankur22 ankur22 commented Nov 13, 2023

What?

Adds the page.throttleCPU and page.throttleNetwork changes to the release notes which were implemented in the browser module.

Why?

To notify users of the latest new feature.

Checklist

  • I have performed a self-review of my code.
  • I have added tests for my changes.
  • I have run linter locally (make 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)

Updates: grafana/xk6-browser#887

@ankur22 ankur22 changed the base branch from master to release-notes-v0.48.0 November 13, 2023 17:41
@codecov-commenter
Copy link

codecov-commenter commented Nov 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release-notes-v0.48.0@7eeb817). Click here to learn what that means.

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

Additional details and impacted files
@@                   Coverage Diff                    @@
##             release-notes-v0.48.0    #3453   +/-   ##
========================================================
  Coverage                         ?   73.36%           
========================================================
  Files                            ?      266           
  Lines                            ?    19965           
  Branches                         ?        0           
========================================================
  Hits                             ?    14647           
  Misses                           ?     4408           
  Partials                         ?      910           
Flag Coverage Δ
ubuntu 73.30% <0.00%> (?)
windows 73.22% <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.

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.

In general it LGTM. I think the examples are good as they are.
As usual I'm doubtful if we should link to some sort of documentation or not, because for example for CPU and network throttling we are mentioning the CPU and network profiles, but it's not clear what fields are available for this.

release notes/v0.48.0.md Outdated Show resolved Hide resolved
release notes/v0.48.0.md Outdated Show resolved Hide resolved
@ankur22
Copy link
Contributor Author

ankur22 commented Nov 16, 2023

As usual I'm doubtful if we should link to some sort of documentation or not, because for example for CPU and network throttling we are mentioning the CPU and network profiles, but it's not clear what fields are available for this.

Thanks for the review! Yep, I wasn't sure either and hoping for some advice on this in the PR. I'll explore adding a bit more detail in here and see if that works. I think linking to docs is also a good approach although I don't feel the docs are stable enough to warrant that yet. Happy to add links though if others have a strong opinion on it.

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.

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.

👍

@ankur22 ankur22 merged commit 2af68e5 into release-notes-v0.48.0 Nov 21, 2023
21 checks passed
@ankur22 ankur22 deleted the add/throttling branch November 21, 2023 14:13
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.

5 participants