opentelemetry-rust icon indicating copy to clipboard operation
opentelemetry-rust copied to clipboard

Try rename opentelemetry_sdk to opentelemetry-sdk

Open cijothomas opened this issue 1 year ago • 4 comments

Fixes # Design discussion issue (if applicable) #

Changes

Please provide a brief description of the changes here.

Merge requirement checklist

  • [ ] CONTRIBUTING guidelines followed
  • [ ] Unit tests added/updated (if applicable)
  • [ ] Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
  • [ ] Changes in public API reviewed (if applicable)

cijothomas avatar May 15 '24 18:05 cijothomas

This might have ramification on how or if this can be pushed to crates.io, I suspect. Should we consult with someone with more knowledge of the cargo publishing process to understand the consequences?

shaun-cox avatar May 15 '24 18:05 shaun-cox

This might have ramification on how or if this can be pushed to crates.io, I suspect. Should we consult with someone with more knowledge of the cargo publishing process to understand the consequences?

yes, I intend to do some research before attempting! Thanks.

cijothomas avatar May 15 '24 18:05 cijothomas

We could consider posting a notice to https://rustsec.org/contributing.html about opentelemetry_sdk -> opentelemetry-sdk Perhaps also we could try to write a wrapper for at least one version which just has opentelemetry_sdk wrapping opentelemetry-sdk directly.

hdost avatar Aug 20 '24 16:08 hdost

Is there some related issue with the discussion about the rename? The naming consistency should be fixed indeed, but I'd like to read about why you picked to normalize using - (compared to normalizing the other crates to _). The reason why I'm asking is that both styles are present on crates.io. - feels a bit more popular, but many larger crates also use _ since it means that the crate name and import name match.

demurgos avatar Aug 30 '24 22:08 demurgos

Is there some related issue with the discussion about the rename? The naming consistency should be fixed indeed, but I'd like to read about why you picked to normalize using - (compared to normalizing the other crates to _). The reason why I'm asking is that both styles are present on crates.io. - feels a bit more popular, but many larger crates also use _ since it means that the crate name and import name match.

There is no other discussion in this repo about this topic. Since opentelemetry_sdk was the outlier, I tried to make it change to use "-", instead of trying every other crate switch to "_".

but many larger crates also use _ since it means that the crate name and import name match.

Yes I noticed that too!

cijothomas avatar Dec 18 '24 19:12 cijothomas

Closing now, keeping a new issue to track this: https://github.com/open-telemetry/opentelemetry-rust/issues/2826

cijothomas avatar Mar 18 '25 14:03 cijothomas