-
Notifications
You must be signed in to change notification settings - Fork 41
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
Conversation
There was a problem hiding this 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.
release notes/v0.9.0.md
Outdated
@@ -0,0 +1,111 @@ | |||
k6-browser `v0.9.0` is here 🎉! This release includes: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 tov0.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 :)
There was a problem hiding this comment.
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
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amended in d686c1c
There was a problem hiding this 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this 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.
Release notes were merged into k6 release notes: grafana/k6#3024 |
These release notes will likely be moved to k6, but are here temporarily for us to work on as a team.