Skip to content

Commit 328b0c7

Browse files
committed
Create CHANGELOG.md for easier communication of library changes, especially possible breaking changes.
Signed-off-by: Owen Williams <[email protected]>
1 parent 8975dde commit 328b0c7

File tree

3 files changed

+73
-1
lines changed

3 files changed

+73
-1
lines changed

CHANGELOG.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Changelog
2+
3+
## main / unreleased
4+
5+
### What's Changed
6+
7+
* [ENHANCEMENT] Create CHANGELOG.md for easier communication of library changes, especially possible breaking changes. https://github.com/prometheus/common/pull/833
8+
9+
## v0.66.1 / 2025-09-05
10+
11+
This release has no functional changes, it just drops the dependencies `github.com/grafana/regexp` and `go.uber.org/atomic` and replaces `gopkg.in/yaml.v2` with `go.yaml.in/yaml/v2` (a drop-in replacement).
12+
13+
### What's Changed
14+
* Revert "Use github.com/grafana/regexp instead of regexp" by @aknuds1 in https://github.com/prometheus/common/pull/835
15+
* Move to supported version of yaml parser by @dims in https://github.com/prometheus/common/pull/834
16+
* Revert "Use go.uber.org/atomic instead of sync/atomic (#825)" by @aknuds1 in https://github.com/prometheus/common/pull/838
17+
18+
**Full Changelog**: https://github.com/prometheus/common/compare/v1.20.99...v0.66.1
19+
20+
## v0.66.0 / 2025-09-02
21+
22+
### ⚠️ Breaking Changes ⚠️
23+
24+
* A default-constructed TextParser will be invalid. It must have a valid `scheme` set, so users should use the NewTextParser function to create a valid TextParser. Otherwise parsing will panic with "Invalid name validation scheme requested: unset".
25+
26+
### What's Changed
27+
* model: add constants for type and unit labels. by @bwplotka in https://github.com/prometheus/common/pull/801
28+
* model.ValidationScheme: Support encoding as YAML by @aknuds1 in https://github.com/prometheus/common/pull/799
29+
* fix(promslog): always print time.Duration values as go duration strings by @tjhop in https://github.com/prometheus/common/pull/798
30+
* Add `ValidationScheme` methods `IsValidMetricName` and `IsValidLabelName` by @aknuds1 in https://github.com/prometheus/common/pull/806
31+
* Fix delimited proto not escaped correctly by @thampiotr in https://github.com/prometheus/common/pull/809
32+
* Decoder: Remove use of global name validation and add validation by @ywwg in https://github.com/prometheus/common/pull/808
33+
* ValidationScheme implements pflag.Value and json.Marshaler/Unmarshaler interfaces by @juliusmh in https://github.com/prometheus/common/pull/807
34+
* expfmt: Add NewTextParser function by @aknuds1 in https://github.com/prometheus/common/pull/816
35+
36+
* Enable the godot linter by @aknuds1 in https://github.com/prometheus/common/pull/821
37+
* Enable usestdlibvars linter by @aknuds1 in https://github.com/prometheus/common/pull/820
38+
* Enable unconvert linter by @aknuds1 in https://github.com/prometheus/common/pull/819
39+
* Enable the fatcontext linter by @aknuds1 in https://github.com/prometheus/common/pull/822
40+
* Enable gocritic linter by @aknuds1 in https://github.com/prometheus/common/pull/818
41+
* Use go.uber.org/atomic instead of sync/atomic by @aknuds1 in https://github.com/prometheus/common/pull/825
42+
* Enable revive rule unused-parameter by @aknuds1 in https://github.com/prometheus/common/pull/824
43+
* Enable revive rules by @aknuds1 in https://github.com/prometheus/common/pull/823
44+
* Synchronize common files from prometheus/prometheus by @prombot in https://github.com/prometheus/common/pull/802
45+
* Synchronize common files from prometheus/prometheus by @prombot in https://github.com/prometheus/common/pull/803
46+
* Sync .golangci.yml with prometheus/prometheus by @aknuds1 in https://github.com/prometheus/common/pull/817
47+
* ci: update upload-actions by @ywwg in https://github.com/prometheus/common/pull/814
48+
* docs: fix typo in expfmt.Negotiate by @wmcram in https://github.com/prometheus/common/pull/813
49+
* build(deps): bump golang.org/x/net from 0.40.0 to 0.41.0 by @dependabot[bot] in https://github.com/prometheus/common/pull/800
50+
* build(deps): bump golang.org/x/net from 0.41.0 to 0.42.0 by @dependabot[bot] in https://github.com/prometheus/common/pull/810
51+
* build(deps): bump github.com/stretchr/testify from 1.10.0 to 1.11.1 in /assets by @dependabot[bot] in https://github.com/prometheus/common/pull/826
52+
* build(deps): bump google.golang.org/protobuf from 1.36.6 to 1.36.8 by @dependabot[bot] in https://github.com/prometheus/common/pull/830
53+
* build(deps): bump golang.org/x/net from 0.42.0 to 0.43.0 by @dependabot[bot] in https://github.com/prometheus/common/pull/829
54+
* build(deps): bump github.com/stretchr/testify from 1.10.0 to 1.11.1 by @dependabot[bot] in https://github.com/prometheus/common/pull/827
55+
56+
### New Contributors
57+
* @aknuds1 made their first contribution in https://github.com/prometheus/common/pull/799
58+
* @thampiotr made their first contribution in https://github.com/prometheus/common/pull/809
59+
* @wmcram made their first contribution in https://github.com/prometheus/common/pull/813
60+
* @juliusmh made their first contribution in https://github.com/prometheus/common/pull/807
61+

RELEASE.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,17 @@ With those steps done, you can proceed to cut a release.
1111

1212
## How to cut an individual release
1313

14-
There is no automated process for cutting a release in `prometheus/common`. A manual release using GitHub's release feature via [this link](https://github.com/prometheus/prometheus/releases/new) is the best way to go. The tag name must be prefixed with a `v` e.g. `v0.53.0` and then you can use the "Generate release notes" button to generate the release note automagically ✨. No need to create a discussion or mark it a pre-release, please do mark it as the latest release if needed.
14+
There is no automated process for cutting a release in `prometheus/common`.
15+
The primary trigger for announcing a release is pushing a new version tag.
16+
17+
NOTE: As soon as a new tag is created, many downstream projects will automatically create pull requests to update their dependency of prom/common.
18+
Make sure the release is ready to go, with an updated changelog including notices of any breaking changes, before pushing a new tag.
19+
20+
Here are the basic steps:
21+
22+
1. Update VERSION, applying the next logical version number, without any `v` prefix (e.g. `0.53.0`).
23+
2. Update CHANGELOG.md, applying the new version number (this time including the `v` prefix, e.g. `v0.53.0`) and date to the changes listed under ``## main / unreleased`, and commit those changes to the main branch.
24+
2. Use GitHub's release feature via [this link](https://github.com/prometheus/prometheus/releases/new) to apply a new tag. The tag name must be prefixed with a `v` e.g. `v0.53.0` and then use the "Generate release notes" button to generate the release notes automagically ✨. No need to create a discussion or mark it a pre-release, please do make sure it is marked as the latest release.
1525

1626
## Versioning strategy
1727

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.66.1

0 commit comments

Comments
 (0)