Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Specify OTel version in README #246

Merged
merged 2 commits into from
Sep 12, 2022
Merged

Specify OTel version in README #246

merged 2 commits into from
Sep 12, 2022

Conversation

pkanal
Copy link
Contributor

@pkanal pkanal commented Sep 12, 2022

Which problem is this PR solving?

Specifies the OTel version the distro is using in the README

Short description of the changes

  • Adds a badge indicating whether dependencies are up to date
  • Adds a nuget version badge for the Honeycomb.OpenTelemetry package
  • Adds a line in the README that indicates what version of OTel is being used

Context

There wasn't a great automated way I could find to indicate the version of OTel that this distro is using. Nuget package version badges only show the latest version and there doesn't seem to be support for looking inside a .csproj file to figure out what dependent version is being used. So for now I think we should use a combination of the "dependencies up to date" badge and specifying the version of OpenTelemetry manually in the README.

@pkanal pkanal added type: documentation Improvements or additions to documentation version: no bump A PR with maintenance or doc changes that aren't included in a release. labels Sep 12, 2022
@pkanal pkanal marked this pull request as ready for review September 12, 2022 17:26
@pkanal pkanal requested review from a team and emilyashley September 12, 2022 17:26
@pkanal pkanal self-assigned this Sep 12, 2022
README.md Outdated Show resolved Hide resolved
Co-authored-by: Jamie Danielson <[email protected]>
Copy link
Contributor

@JamieDanielson JamieDanielson left a comment

Choose a reason for hiding this comment

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

essential badge

@pkanal pkanal merged commit 3e9905e into main Sep 12, 2022
@pkanal pkanal deleted the purvi.otel-version-readme branch September 12, 2022 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation version: no bump A PR with maintenance or doc changes that aren't included in a release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it more clear what version of OTel this is built against
2 participants