diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e1588f..8ea4c5e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +## 1.0.0 / 2019-06-15 + +_This release removes all previously deprecated features, resulting in the breaking changes listed below. As this is v1.0.0, semantic versioning applies from now on, with the exception of the API client and parts marked explicitly as experimental._ + +* [CHANGE] Remove objectives from the default `Summary`. (Objectives have to be set explicitly in the `SummaryOpts`.) #600 +* [CHANGE] Remove all HTTP related feature in the `prometheus` package. (Use the `promhttp` package instead.) #600 +* [CHANGE] Remove `push.FromGatherer`, `push.AddFromGatherer`, `push.Collectors`. (Use `push.New` instead.) #600 +* [CHANGE] API client: Pass warnings through on non-error responses. #599 +* [CHANGE] API client: Add warnings to `Series` call. #603 +* [FEATURE] Make process collector work on Microsoft Windows. **EXPERIMENTAL** #596 +* [FEATURE] API client: Add `/labels` call. #604 +* [BUGFIX] Make `AlreadyRegisteredError` usable for wrapped registries. #607 + ## 0.9.4 / 2019-06-07 * [CHANGE] API client: Switch to alert values as strings. #585 * [FEATURE] Add a collector for Go module build information. #595 diff --git a/README.md b/README.md index 2336eb1..f02060a 100644 --- a/README.md +++ b/README.md @@ -11,41 +11,23 @@ Prometheus HTTP API. __This library requires Go1.9 or later.__ -## Important note about releases, versioning, tagging, and stability +## Important note about releases and stability -In this repository, we used to mostly ignore the many coming and going -dependency management tools for Go and instead wait for a tool that most of the -community would converge on. Our bet is that this tool has arrived now in the -form of [Go -Modules](https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies). +This repository generally follows [Semantic +Versioning](https://semver.org/). However, the API client in +prometheus/client_golang/api/… is still considered experimental. Breaking +changes of the API client will _not_ trigger a new major release. The same is +true for selected other new features explicitly marked as **EXPERIMENTAL** in +CHANGELOG.md. -To make full use of what Go Modules are offering, the previous versioning -roadmap for this repository had to be changed. In particular, Go Modules -finally provide a way for incompatible versions of the same package to coexist -in the same binary. For that, however, the versions must be tagged with -different major versions of 1 or greater (following [Semantic -Versioning](https://semver.org/)). Thus, we decided to abandon the original -plan of introducing a lot of breaking changes _before_ releasing v1 of this -repository, mostly driven by the widespread use this repository already has and -the relatively stable state it is in. - -To leverage the mechanism Go Modules offers for a transition between major -version, the current plan is the following: - -- The v0.9.x series of releases will see a small number of bugfix releases to - deal with a few remaining minor issues (#543, #542, #539). -- After that, all features currently marked as _deprecated_ will be removed, - and the result will be released as v1.0.0. -- The planned breaking changes previously gathered as part of the v0.10 - milestone will now go into the v2 milestone. The v2 development happens in a - [separate branch](https://github.com/prometheus/client_golang/tree/dev-v2) - for the time being. v2 releases off that branch will happen once sufficient - stability is reached. v1 and v2 will coexist for a while to enable a - convenient transition. -- The API client in prometheus/client_golang/api/… is still considered - experimental. While it will be tagged alongside the rest of the code - according to the plan above, we cannot strictly guarantee semver semantics - for it. +Features that require breaking changes in the stable parts of the repository +are being batched up and tracked in the [v2 +milestone](https://github.com/prometheus/client_golang/milestone/2). The v2 +development happens in a [separate +branch](https://github.com/prometheus/client_golang/tree/dev-v2) for the time +being. v2 releases off that branch will happen once sufficient stability is +reached. In view of the widespread use of this repository, v1 and v2 will +coexist for a while to enable a convenient transition. ## Instrumenting applications diff --git a/VERSION b/VERSION index a602fc9..3eefcb9 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.9.4 +1.0.0