[chore] add chloggen for changelog #6062

codeboten · 2022-09-13T21:20:01Z

This change updates the changelog process in this repo to match the process in the contrib repo.

codecov · 2022-09-13T21:27:57Z

Codecov Report

Base: 92.03% // Head: 92.22% // Increases project coverage by +0.18% 🎉

Coverage data is based on head (462f55e) compared to base (a9f41a2).
Patch has no changes to coverable lines.

❗ 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%)`	⬇️
service/service.go	`68.42% <0.00%> (-3.01%)`	⬇️
...er/loggingexporter/internal/otlptext/databuffer.go	`98.26% <0.00%> (-1.74%)`	⬇️
confmap/resolver.go	`97.20% <0.00%> (-0.94%)`	⬇️
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.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

jpkrohling

Looks good, but perhaps there's something small missing?

$ make chlog-update VERSION=v0.60.0
cd ./internal/tools && go install go.opentelemetry.io/build-tools/chloggen
chloggen update -version v0.60.0
FAIL: update: expected one instance of <!-- next version -->

make: *** [Makefile:458: chlog-update] Error 1

codeboten

@jpkrohling I was waiting for the release to be done before updating the changelog & updating the files in the unreleased directory

bogdandrutu · 2022-09-15T14:11:52Z

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?

djaglowski

LGTM, but consider adding this section to CONTRIBUTING.md.

djaglowski · 2022-09-16T14:27:35Z

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.

TylerHelmuth · 2022-09-16T14:51:21Z

I'd vote for unreleased_log (or unreleased_logs or unrelease_chlog) in both repos. Something that indicates these are future changelog entries.

djaglowski · 2022-09-26T17:54:59Z

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.

codeboten · 2022-09-26T20:20:19Z

👍🏻 im ok with a hidden .chloggen directory. It should be easy enough to update chloggen to make this directory configurable

Currently `chloggen` defaults to looking for unreleased change log entries in `unreleased`. This causes some confusion as per open-telemetry/opentelemetry-collector#6062. With this change, the default directory for `chloggen` becomes `.chloggen`. The `chloggen-directory` flag has been added to give users additional flexibility.

codeboten · 2022-09-27T18:31:54Z

@djaglowski @bogdandrutu PTAL at open-telemetry/opentelemetry-go-build-tools#145 to update the default directory to .chloggen.

I plan on updating the contrib repo to match .chloggen once that change is merged.

Currently `chloggen` defaults to looking for unreleased change log entries in `unreleased`. This causes some confusion as per open-telemetry/opentelemetry-collector#6062. With this change, the default directory for `chloggen` becomes `.chloggen`. The `chloggen-directory` flag has been added to give users additional flexibility. Co-authored-by: Daniel Jaglowski <[email protected]>

djaglowski

LGTM

.chloggen/TEMPLATE.yaml

codeboten · 2022-10-03T17:04:55Z

@bogdandrutu @jpkrohling PTAL

internal/tools/go.mod

codeboten · 2022-10-07T19:45:02Z

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

Aneurysm9 · 2022-10-07T20:58:20Z

internal/tools/go.mod

@@ -11,10 +11,11 @@ require (
 github.com/pavius/impi v0.0.3
 github.com/tcnksm/ghr v0.16.0
 github.com/wadey/gocovmerge v0.0.0-20160331181800-b5bfa59ec0ad
- go.opentelemetry.io/build-tools/checkdoc v0.0.0-20220919170044-dd98e8af322a
+ go.opentelemetry.io/build-tools/checkdoc v0.0.0-20220928154055-b00fb8eb9066


These can be updated to v0.1.0.

jpkrohling

I'm in favor of this change. It's not critical for core as it is for contrib, but it's nonetheless an improvement.

This change updates the changelog process in this repo to match the process in the contrib repo.

* upgrade otel go to latest version v1.11.0/v0.32.3/v0.36.3 (#6293) * [chore] move service pipeline id validation to main config Validate (#6281) Signed-off-by: Bogdan <[email protected]> Signed-off-by: Bogdan <[email protected]> * Instrument obsreport.receiver metrics with otel go (#6222) * Instrument obs_receiver with otel go * add changelog entry * remove views configuration * move otel-go metrics to obsreport * add UseOtelForMetrics to TelemetrySettings; extract otel sdk initialization changes to another pr; remove public InstrumentWithOtel from obsreport; * default UseOtelForMetrics to false * remove duplicate oc registry initialization * move `UseOtelForMetrics` to the internal package `obsreportconfig` * address comments * only register view if featuregate is disabled * prefix meter name with `receiver/` * change meter scope name * upgrade otel metric sdk * run make gotidy * update changelog * revert: otel go version upgrade * revert: x/sys upgrades * [chore] add chloggen for changelog (#6062) This change updates the changelog process in this repo to match the process in the contrib repo. * Fix support for new line in config URI location Signed-off-by: Bogdan <[email protected]> Signed-off-by: Bogdan <[email protected]> Co-authored-by: Gustavo Paiva <[email protected]> Co-authored-by: Alex Boten <[email protected]>

jpkrohling reviewed Sep 14, 2022

View reviewed changes

codeboten force-pushed the codeboten/changelog branch from 341a2fa to 94450b0 Compare September 15, 2022 02:08

codeboten marked this pull request as ready for review September 15, 2022 02:08

codeboten requested review from a team and Aneurysm9 September 15, 2022 02:08

codeboten commented Sep 15, 2022

View reviewed changes

djaglowski approved these changes Sep 16, 2022

View reviewed changes

codeboten mentioned this pull request Sep 27, 2022

[chloggen] add chloggen-directory flag open-telemetry/opentelemetry-go-build-tools#145

Merged

codeboten force-pushed the codeboten/changelog branch from 94450b0 to a072a60 Compare September 28, 2022 21:11

djaglowski approved these changes Sep 29, 2022

View reviewed changes

TylerHelmuth approved these changes Sep 29, 2022

View reviewed changes

.chloggen/TEMPLATE.yaml Outdated Show resolved Hide resolved

codeboten force-pushed the codeboten/changelog branch 2 times, most recently from cc99f80 to d348493 Compare October 3, 2022 17:04

jpkrohling reviewed Oct 4, 2022

View reviewed changes

internal/tools/go.mod Outdated Show resolved Hide resolved

codeboten force-pushed the codeboten/changelog branch from d348493 to 462f55e Compare October 5, 2022 21:24

Aneurysm9 approved these changes Oct 7, 2022

View reviewed changes

jpkrohling approved these changes Oct 11, 2022

View reviewed changes

tigrannajaryan approved these changes Oct 11, 2022

View reviewed changes

mx-psi approved these changes Oct 13, 2022

View reviewed changes

[chore] add chloggen for changelog

9a7f60d

This change updates the changelog process in this repo to match the process in the contrib repo.

codeboten force-pushed the codeboten/changelog branch from 462f55e to 9a7f60d Compare October 13, 2022 15:20

codeboten merged commit f24a6ac into open-telemetry:main Oct 13, 2022

codeboten deleted the codeboten/changelog branch October 13, 2022 15:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[chore] add chloggen for changelog #6062

[chore] add chloggen for changelog #6062

codeboten commented Sep 13, 2022 •

edited

Loading

codecov bot commented Sep 13, 2022 •

edited

Loading

jpkrohling left a comment

codeboten left a comment

bogdandrutu commented Sep 15, 2022

djaglowski left a comment

djaglowski commented Sep 16, 2022

TylerHelmuth commented Sep 16, 2022

djaglowski commented Sep 26, 2022

codeboten commented Sep 26, 2022

codeboten commented Sep 27, 2022

djaglowski left a comment

codeboten commented Oct 3, 2022

codeboten commented Oct 7, 2022

Aneurysm9 Oct 7, 2022

jpkrohling left a comment

[chore] add chloggen for changelog #6062

[chore] add chloggen for changelog #6062

Conversation

codeboten commented Sep 13, 2022 • edited Loading

codecov bot commented Sep 13, 2022 • edited Loading

Codecov Report

jpkrohling left a comment

Choose a reason for hiding this comment

codeboten left a comment

Choose a reason for hiding this comment

bogdandrutu commented Sep 15, 2022

djaglowski left a comment

Choose a reason for hiding this comment

djaglowski commented Sep 16, 2022

TylerHelmuth commented Sep 16, 2022

djaglowski commented Sep 26, 2022

codeboten commented Sep 26, 2022

codeboten commented Sep 27, 2022

djaglowski left a comment

Choose a reason for hiding this comment

codeboten commented Oct 3, 2022

codeboten commented Oct 7, 2022

Aneurysm9 Oct 7, 2022

Choose a reason for hiding this comment

jpkrohling left a comment

Choose a reason for hiding this comment

codeboten commented Sep 13, 2022 •

edited

Loading

codecov bot commented Sep 13, 2022 •

edited

Loading