You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
This updates the bugfix guidelines to make them less strict. In
particular, after this change, we would start releasing bugfix releases
under the following cases:
1. Lack of consensus of SIG leads on whether to release a bugfix version
within one working day after a report has been made
2. Issues that have not been reported by multiple people, but that are
known to be used in production
This also:
- Explicitly lists difficulties with debugging and troubleshooting as
'severe enough'
- Explicitly states that the release manager is responsible for bugfix
releases
Copy file name to clipboardExpand all lines: docs/release.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -178,20 +178,22 @@ When considering making a bugfix release on the `v0.N.x` release cycle, the bug
178
178
- Changing the configuration to an easy to find value.
179
179
2. The bug happens in common setups. To gauge this, maintainers can consider the following:
180
180
- If the bug is specific to a certain platform, and if that platform is in [Tier 1](../docs/platform-support.md#tiered-platform-support-model).
181
-
- The bug happens with the default configuration or with a commonly used one (e.g. has been reported by multiple people)
181
+
- The bug happens with the default configuration or with one that is known to be used in production.
182
182
3. The bug is sufficiently severe. For example (non-exhaustive list):
183
183
- The bug makes the Collector crash reliably
184
184
- The bug makes the Collector fail to start under an accepted configuration
185
185
- The bug produces significant data loss
186
186
- The bug makes the Collector negatively affect its environment (e.g. significantly affects its host machine)
187
+
- The bug makes it difficult to troubleshoot or debug Collector setups
187
188
188
189
We aim to provide a release that fixes security-related issues in at most 30 days since they are publicly announced; with the current release schedule this means security issues will typically not warrant a bugfix release. An exception is critical vulnerabilities (CVSSv3 score >= 9.0), which will warrant a release within five business days.
189
190
190
191
The OpenTelemetry Collector maintainers will ultimately have the responsibility to assess if a given bug or security issue fulfills all the necessary criteria and may grant exceptions in a case-by-case basis.
192
+
If the maintainers are unable to reach consensus within one working day, we will lean towards releasing a bugfix version.
191
193
192
194
### Bugfix release procedure
193
195
194
-
The following documents the procedure to release a bugfix
196
+
The release manager of a minor version is responsible for releasing any bugfix versions on this release series. The following documents the procedure to release a bugfix
195
197
196
198
1. Create a pull request against the `release/<release-series>` (e.g. `release/v0.90.x`) branch to apply the fix.
197
199
2. Make sure you are on `release/<release-series>`. Prepare release commits with `prepare-release` make target, e.g. `make prepare-release PREVIOUS_VERSION=0.90.0 RELEASE_CANDIDATE=0.90.1 MODSET=beta`, and create a pull request against the `release/<release-series>` branch.
0 commit comments