Update README.md and UPGRADING.md for 3.0.0 release#243
Merged
Conversation
84c1efa to
4bd2e08
Compare
dmagliola
approved these changes
Jan 10, 2022
Collaborator
dmagliola
left a comment
There was a problem hiding this comment.
Should we update UPGRADING.md too with the push client changes?
Member
Author
|
Yeah, let's go for it. I was on the fence since we didn't for the last breaking release (2.0.0), but it seems like a nice thing to do for users. |
0b78158 to
76d6677
Compare
Member
Author
|
bruh |
fa79b34 to
87d7139
Compare
We've made a bunch of breaking changes recently, which will be part of the 3.0.0 release. This commit updates our README to match the new API in anticipation of that relese. Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
d7999b7 to
f58ab64
Compare
Member
Author
|
@dmagliola I've pushed what I think is a complete set of notes on breaking changes in the 3.x.x series. Should be ready for a once over! |
Prometheus::Client::Pushf58ab64 to
588446c
Compare
dmagliola
reviewed
Jan 28, 2022
| In line with changes we made for the 0.10.0 release (see below), | ||
| `Prometheus::Client::Push` now favours the use of keyword arguments for improved clarity | ||
| at the callsites. Specifically, the constructor now takes several keyword arguments rather | ||
| than relying entirely on keyword arguments. Where you would previously have written: |
Collaborator
There was a problem hiding this comment.
on positional arguments?
dmagliola
approved these changes
Jan 28, 2022
Collaborator
dmagliola
left a comment
There was a problem hiding this comment.
One tiny typo, otherwise :chefs_kiss:
Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
588446c to
3f4ed61
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

We've made a bunch of breaking changes recently, which will be part of
the 3.0.0 release. This commit updates our README to match the new API
in anticipation of that relese.
Fixes #240