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

config: prepare package for release #4541

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

codeboten
Copy link
Contributor

@codeboten codeboten commented Nov 9, 2023

This PR does the following:

  • adds a section to versions.yaml, please review that the new section makes sense, it didn't seem to fit in any of the other groups.
  • adds doc.go

Fixes #4415

@codeboten codeboten force-pushed the codeboten/config-release branch from 20ead20 to eb3f372 Compare November 9, 2023 16:01
Copy link

codecov bot commented Nov 9, 2023

Codecov Report

Merging #4541 (df698a8) into main (016b46f) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is 0.0%.

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #4541   +/-   ##
=====================================
  Coverage   80.8%   80.8%           
=====================================
  Files        150     150           
  Lines      10371   10371           
=====================================
  Hits        8387    8387           
  Misses      1840    1840           
  Partials     144     144           
Files Coverage Δ
config/config.go 100.0% <ø> (ø)
instrumentation/host/host.go 0.0% <0.0%> (ø)

This PR does the following:

- adds a section to versions.yaml, please review that the new section makes sense, it didn't seem to fit in any of the other groups.
- adds doc.go
- adds example

Signed-off-by: Alex Boten <aboten@lightstep.com>
@codeboten codeboten force-pushed the codeboten/config-release branch from eb3f372 to 3e4eee5 Compare November 9, 2023 16:14
@codeboten codeboten marked this pull request as ready for review November 9, 2023 16:14
@codeboten codeboten requested a review from a team November 9, 2023 16:14
@codeboten
Copy link
Contributor Author

@pellared does this type of change require a changelog? Happy to add one, I just wasn't sure :)

@codeboten codeboten changed the title [config] prepare package for release config: prepare package for release Nov 9, 2023
@pellared pellared added the Skip Changelog Allow PR to succeed without requiring an addition to the CHANGELOG label Nov 9, 2023
@pellared
Copy link
Member

pellared commented Nov 9, 2023

  1. Can we remove README.md so that its content is not displayed in pkgsite (pkg.go.dev)?
  2. Can we document (even as a TODO comment refering to config: Create SDK from model #4371) that NewSDK is not really implemented?

@pellared
Copy link
Member

pellared commented Nov 9, 2023

@pellared does this type of change require a changelog? Happy to add one, I just wasn't sure :)

I added a "Skip Changelog" label.

Signed-off-by: Alex Boten <aboten@lightstep.com>
@codeboten
Copy link
Contributor Author

  1. Can we remove README.md so that its content is not displayed in pkgsite (pkg.go.dev)?

    1. Can we document (even as a TODO comment refering to config: Create SDK from model #4371) that NewSDK is not really implemented?

The readme has been removed, and todo's added in config.go. PTAL

@pellared
Copy link
Member

pellared commented Nov 9, 2023

todo's added in config.go.

PS. I was thinking about adding TODO to NewSDK doc comment. I need to be more clear in future. But we can leave it as it is 😄

@pellared pellared merged commit c1ac303 into open-telemetry:main Nov 10, 2023
@codeboten codeboten deleted the codeboten/config-release branch November 10, 2023 13:49
@pellared pellared added this to the untracked milestone Nov 8, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Skip Changelog Allow PR to succeed without requiring an addition to the CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

config: Prepare for release
3 participants