opentelemetry-collector
opentelemetry-collector copied to clipboard
[chore] add chloggen for changelog
This change updates the changelog process in this repo to match the process in the contrib repo.
Fixes #5647
~Keeping this as a draft until the next release to avoid having to translate all the current changes in the changelog into individual yaml files.~
Codecov Report
Base: 92.03% // Head: 92.22% // Increases project coverage by +0.18%
:tada:
Coverage data is based on head (
462f55e
) compared to base (a9f41a2
). Patch has no changes to coverable lines.
:exclamation: Current head 462f55e differs from pull request most recent head 9a7f60d. Consider uploading reports for the commit 9a7f60d to get more accurate results
Additional details and impacted files
@@ Coverage Diff @@
## main #6062 +/- ##
==========================================
+ Coverage 92.03% 92.22% +0.18%
==========================================
Files 218 219 +1
Lines 13203 13484 +281
==========================================
+ Hits 12151 12435 +284
+ Misses 832 819 -13
- Partials 220 230 +10
Impacted Files | Coverage Δ | |
---|---|---|
pdata/internal/wrapper_metrics.go | 52.17% <0.00%> (-47.83%) |
:arrow_down: |
service/service.go | 68.42% <0.00%> (-3.01%) |
:arrow_down: |
...er/loggingexporter/internal/otlptext/databuffer.go | 98.26% <0.00%> (-1.74%) |
:arrow_down: |
confmap/resolver.go | 97.20% <0.00%> (-0.94%) |
:arrow_down: |
pdata/plog/logs.go | 96.00% <0.00%> (ø) |
|
config/moved_config.go | 100.00% <0.00%> (ø) |
|
obsreport/obsreport.go | 100.00% <0.00%> (ø) |
|
pdata/pmetric/metrics.go | 100.00% <0.00%> (ø) |
|
...e/internal/configunmarshaler/defaultunmarshaler.go | 100.00% <0.00%> (ø) |
|
config/internal/configsource/manager.go | 85.95% <0.00%> (ø) |
|
... and 4 more |
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.
I found very bad naming 'unreleased' in contrib. It sounds to me like an unreleased code. Can we have different name or under another directory in docs?
I found very bad naming 'unreleased' in contrib. It sounds to me like an unreleased code. Can we have different name or under another directory in docs?
I can see why it sounds like actual code would be contained there. The word came directly out of the previous version of the changelog (ie. Unreleased changes). I considered changelog/
but thought unreleased
was better because it does not imply that it would contain the complete history of changes. Maybe .unreleased
or unreleased_log
?
The placement at the root of the repo was with developer experience in mind. I thought this would make it easy to find and therefore easy to adapt to the new process. Less important on core where we have fewer contributors though.
I'd vote for unreleased_log
(or unreleased_logs
or unrelease_chlog
) in both repos. Something that indicates these are future changelog entries.
I think this is ready, pending a decision on the directory for unreleased change log entries.
What do others think of .chloggen/
? Other tools use a dedicated hidden directory at the root of the project, so I think this is somewhat intuitive.
👍🏻 im ok with a hidden .chloggen directory. It should be easy enough to update chloggen to make this directory configurable
@djaglowski @bogdandrutu PTAL at https://github.com/open-telemetry/opentelemetry-go-build-tools/pull/145 to update the default directory to .chloggen
.
I plan on updating the contrib repo to match .chloggen
once that change is merged.
@bogdandrutu @jpkrohling PTAL
Keeping this PR updated is somewhat painful (as it conflicts every time the changelog is updated). I'd like to get approvals from others @open-telemetry/collector-approvers before updating it again. Otherwise we can always close it