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 a release notes for v0.9.0 #845

Closed
wants to merge 3 commits into from
Closed

Add a release notes for v0.9.0 #845

wants to merge 3 commits into from

Conversation

ankur22
Copy link
Collaborator

@ankur22 ankur22 commented Apr 3, 2023

These release notes will likely be moved to k6, but are here temporarily for us to work on as a team.

@ankur22 ankur22 added the documentation Improvements or additions to documentation label Apr 3, 2023
@ankur22 ankur22 added this to the v0.9.0 milestone Apr 3, 2023
@ankur22 ankur22 requested review from inancgumus and ka3de April 3, 2023 15:14
@ankur22 ankur22 self-assigned this Apr 3, 2023
Copy link
Collaborator

@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 @ankur22 ! 👏
Made a few small comments.

@@ -0,0 +1,111 @@
k6-browser `v0.9.0` is here 🎉! This release includes:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm a little bit confused with the naming in docs vs in this repo etc. Should this be k6-browser or xk6-browser? Or even k6 browser here?

Copy link
Contributor

Choose a reason for hiding this comment

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

I believe the module name is still xk6-browser and since we're referring to the module version, I'd suggest we refer to it by its name.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Maybe it's best to remove this summary bit from the top (or at least the first line) since we're going to merge this into the k6 release notes.

Why shouldn't it be k6-browser if these release notes will eventually be merged into k6's?

Copy link
Contributor

Choose a reason for hiding this comment

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

For k6 release notes I'd say it would make sense to rephrase it even further. Something like

The xk6-browser module has been upgraded to v0.9.0, that brings following changes and improvements: ...

The way I think of it as github.com/grafana/xk6-browser, or xk6-browser for short is a Go module that brings [k6 ]browser functionality to k6. Modules are versioned, functionality is not :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, that makes sense. I guess we assume people looking at the release notes are likely to join the dots and see that the experimental browser module is actually called xk6-browser.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Amended in d686c1c

release notes/v0.9.0.md Outdated Show resolved Hide resolved
release notes/v0.9.0.md Outdated Show resolved Hide resolved
release notes/v0.9.0.md Outdated Show resolved Hide resolved
release notes/v0.9.0.md Outdated Show resolved Hide resolved
release notes/v0.9.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.

Very nice, thanks for this :) I've fixed what I could see.

release notes/v0.9.0.md Outdated Show resolved Hide resolved
release notes/v0.9.0.md Outdated Show resolved Hide resolved
release notes/v0.9.0.md Outdated Show resolved Hide resolved
ankur22 added a commit that referenced this pull request Apr 4, 2023
ankur22 added a commit that referenced this pull request Apr 4, 2023
Copy link
Collaborator

@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.

LGTM 👍 Could you also squash the commits? Thanks, @ankur22 :)

These release notes will likely be moved to k6, but are here
temporarily for us to work on as a team.
@ankur22
Copy link
Collaborator Author

ankur22 commented Apr 24, 2023

Release notes were merged into k6 release notes: grafana/k6#3024

@ankur22 ankur22 closed this Apr 24, 2023
@ankur22 ankur22 deleted the release/v0.9.0 branch April 24, 2023 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants