Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[docs] Add bugfix release criteria #5707

Merged
merged 4 commits into from
Jul 25, 2022

Conversation

mx-psi
Copy link
Member

@mx-psi mx-psi commented Jul 19, 2022

Description: Add criteria describing when to make a bugfix release. This is basically a rehash of #5681 (comment) with nicer language and ordered from least to most ambiguous.

Link to tracking Issue: Fixes #5681

cc @codeboten @jpkrohling

@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jul 19, 2022
@mx-psi mx-psi requested review from a team and Aneurysm9 July 19, 2022 15:46
docs/release.md Outdated
- The bug makes the Collector negatively affect its environment (e.g. significantly affects its host machine)

The OpenTelemetry Collector maintainers will ultimately have the responsibility to assess if a given bug fulfills all the necessary criteria.
Exceptions may be granted in a case-by-case basis if there is widespread consensus that a bugfix release should be done despite the above rules.
Copy link
Member Author

@mx-psi mx-psi Jul 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this last line be here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the wiggle room, but I think ultimately the "case-by-case" basis is based on the maintainer's judgement. Could modify the line above to be "The OpenTelemetry Collector maintainers will ultimately have the responsibility to assess if a given bug fulfills all the necessary criteria, or should be patched anyways".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworded

@codecov
Copy link

codecov bot commented Jul 19, 2022

Codecov Report

Merging #5707 (906687d) into main (297249e) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #5707      +/-   ##
==========================================
+ Coverage   91.53%   91.56%   +0.03%     
==========================================
  Files         192      192              
  Lines       11398    11411      +13     
==========================================
+ Hits        10433    10449      +16     
+ Misses        770      768       -2     
+ Partials      195      194       -1     
Impacted Files Coverage Δ
exporter/exporterhelper/queued_retry_inmemory.go 91.89% <0.00%> (-3.70%) ⬇️
exporter/exporterhelper/obsreport.go 100.00% <0.00%> (ø)
config/confighttp/compression.go 84.11% <0.00%> (+5.81%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 297249e...906687d. Read the comment docs.

mx-psi and others added 2 commits July 19, 2022 17:58
Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com>
@mx-psi mx-psi requested a review from TylerHelmuth July 19, 2022 16:23
@mx-psi mx-psi requested review from jpkrohling and codeboten July 22, 2022 15:20
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document requirements for patch releases
5 participants