docs: Add RELEASE.md for the release process #1690
Open
Conversation
This file contains 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
docs: update README for version compatibility Signed-off-by: Kemal Akkoyun <[email protected]>
ArthurSens
reviewed
Nov 20, 2024
| @@ -0,0 +1,152 @@ | |||
| # Release | |||
|
|
|||
| The Prometheus Go client library follows a release process similar to the [Prometheus server](https://github.com/prometheus/prometheus/blob/main/RELEASE.md). | |||
There was a problem hiding this comment.
Is it similar? I have the impression that we do releases when we have a feeling it's needed, there's no schedule here 🤔
There was a problem hiding this comment.
I can explicitly state that we don't have a cadence.
| 8. Announce release: | ||
| - <[email protected]> | ||
| - Slack | ||
| - x.com/BlueSky |
There was a problem hiding this comment.
Do you mean with our personal accounts? Or Prometheus account?
There was a problem hiding this comment.
I don't think it matters. We can use our own accounts and ask someone to repost it.
There was a problem hiding this comment.
I don't think it matters. We can use our own accounts and ask someone to repost it.
ArthurSens
approved these changes
Nov 21, 2024
bwplotka
requested changes
Nov 25, 2024
|
|
||
| - Maintain separate `release-<major>.<minor>` branches | ||
| - Branch protection enabled automatically for `release-*` branches | ||
| - Bug fixes go to latest release branch, then merge to main |
There was a problem hiding this comment.
Suggested change
| - Bug fixes go to latest release branch, then merge to main | |
| - Bug fixes go to the latest release branch, then merge to main |
| - Branch protection enabled automatically for `release-*` branches | ||
| - Bug fixes go to latest release branch, then merge to main | ||
| - Features and changes go to main branch | ||
| - Older release branches maintained on best-effort basis |
There was a problem hiding this comment.
Suggested change
| - Older release branches maintained on best-effort basis | |
| - Non-latest minor release branches are maintained (e.g. bug and security fixes) on the best-effort basis |
|
|
||
| 1. Review main branch state: | ||
| - Expedite critical bug fixes | ||
| - Hold back risky changes |
There was a problem hiding this comment.
Suggested change
| - Hold back risky changes | |
| - Don't rush on risky changes, consider them for the next release if not ready |
| 1. Review main branch state: | ||
| - Expedite critical bug fixes | ||
| - Hold back risky changes | ||
| - Update dependencies via Dependabot PRs |
There was a problem hiding this comment.
Suggested change
| - Update dependencies via Dependabot PRs | |
| - Update dependencies via Dependabot PRs or manually if needed |
| git push origin release-<major>.<minor> | ||
| ``` | ||
|
|
||
| 2. Create feature branch: |
There was a problem hiding this comment.
Suggested change
| 2. Create feature branch: | |
| 2. Create a new branch on top of `release-<major>.<minor>`: |
| 1. **Internal Testing**: | ||
| - Full test suite must pass | ||
| - Integration tests with latest Prometheus server | ||
| - Benchmark comparisons with previous version |
There was a problem hiding this comment.
What do you mean? We don't have any tooling or way right now. Should we skip this and add once we have such a process?
Comment on lines
+134
to
+135
| - Testing with prometheus/prometheus master branch | ||
| - Testing with kubernetes/kubernetes master branch |
There was a problem hiding this comment.
Suggested change
| - Testing with prometheus/prometheus master branch | |
| - Testing with kubernetes/kubernetes master branch | |
| - Testing with prometheus/prometheus main branch | |
| - Testing with kubernetes/kubernetes main branch |
| - Integration tests with latest Prometheus server | ||
| - Benchmark comparisons with previous version | ||
|
|
||
| 2. **External Validation**: |
There was a problem hiding this comment.
Suggested change
| 2. **External Validation**: | |
| 2. **External Validation**: | |
| Test against bigger users, especially looking for broken tests or builds. This will give us awareness of a potential accidental breaking changes, or if there were intentional ones, the potential damage radius of them. |
Comment on lines
+138
to
+143
| ### Version Policy | ||
|
|
||
| - Bug fixes increment patch version (e.g., v0.9.1) | ||
| - New features increment minor version (e.g., v0.10.0) | ||
| - Breaking changes increment minor version with clear documentation | ||
| - Major version remains at 0 to indicate potential instability |
There was a problem hiding this comment.
Copy pasta? It's bit trivial and also wrong (we are not v0 version)
Comment on lines
+145
to
+152
| ### Deprecation Policy | ||
|
|
||
| 1. Features may be deprecated in any minor release | ||
| 2. Deprecated features: | ||
| - Will be documented in CHANGELOG.md | ||
| - Will emit warnings when used (when possible) | ||
| - May be removed in next minor version | ||
| - Must have migration path documented |
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.
docs: update README for version compatibility
fixes #1681
Signed-off-by: Kemal Akkoyun [email protected]