release: initial gRPC instrumentation release under the OpenTelemetry org

[michal-kazmierczak]

This PR provides the final touches for the gRPC instrumentation release. It (probably) closes #1261

I checked the release automation but I'm unsure how the automated release should be handled given that this gem was donated and older versions exist on RubyGems. Could I get some guidance on this?

Also, I think we will be able to add this gem to all once the initial release is done.

[arielvalentin]

If this is the first real release of the gem then set the version to 0.0.0 and use the default changelog heading that is generated from here:

https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.instrumentation_generator/templates/CHANGELOG.md.tt

The release tooling should pick up all related PRs and metion them as part of the initial changlog.

[michal-kazmierczak]

If this is the first real release of the gem then set the version to 0.0.0 and use the default changelog heading that is generated from here:

https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.instrumentation_generator/templates/CHANGELOG.md.tt

The release tooling should pick up all related PRs and metion them as part of the initial changlog.

Thanks for your help. I think we are all set now for the automation.

[arielvalentin]

You will want this file to be empty except for the heading.

[michal-kazmierczak]

Ok! Updated.

[arielvalentin]

@kaylareopelle mind giving this another look?

I think we got it all except fo release please file but we aren't really using that yet so I think its fine.

[kaylareopelle]

Thanks for opening this PR, @michal-kazmierczak and for looping me in, @arielvalentin!

@arielvalentin, even though this is the first release within the OpenTelemetry release tooling, there are already a few versions of this gem with this name out on RubyGems: https://rubygems.org/gems/opentelemetry-instrumentation-grpc

I'd like to keep the release history of the previous versions preserved in the changelog since people can still find them on RubyGems. Can toys support this? I thought it would be acceptable given the format of the changelog file matched what toys would have produced.

[arielvalentin]

Thanks for opening this PR, @michal-kazmierczak and for looping me in, @arielvalentin!

@arielvalentin, even though this is the first release within the OpenTelemetry release tooling, there are already a few versions of this gem with this name out on RubyGems: https://rubygems.org/gems/opentelemetry-instrumentation-grpc

I'd like to keep the release history of the previous versions preserved in the changelog since people can still find them on RubyGems. Can toys support this? I thought it would be acceptable given the format of the changelog file matched what toys would have produced.

No because @hibachrach published it under their account. We would need to figure out how to publish this version of the gem under the opentelemetry account.

I am not sure how to resolve situations where someone publishes a gem that would normally fall under our namespace. In the past @simi has yanked the gem but I believe that was a case where it was a malicious actor.

@simi is there anyway for us to reserve a specific gem namespace like opentelemetry-instrumentation-* to ensure we are the only ones who could publish gems there?

[hibachrach]

@arielvalentin Happy to help in anyway i can (incl. transferring ownership of the gem)

[kaylareopelle]

Hi @michal-kazmierczak, @hibachrach - I'm working behind the scenes on some things to aid the ownership transfer. I hope to have more for you soon!

[kaylareopelle]

Hi @michal-kazmierczak, today I learned all instrumentation needs to have a dependency on the opentelemetry-api at version ~> 1.0. It looks like the GRPC gem currently has the dependency set to ~> 1.2. Would you mind updating the dependency version constraint?

Also, I now can facilitate a gem ownership transfer. @hibachrach, could you follow the instructions on this page? Our username is opentelemetry-ruby.

[michal-kazmierczak]

Hi @michal-kazmierczak, today I learned all instrumentation needs to have a dependency on the opentelemetry-api at version ~> 1.0. It looks like the GRPC gem currently has the dependency set to ~> 1.2. Would you mind updating the dependency version constraint?

I missed that, thank you for pointing out. I've updated it.

[hibachrach]

@kaylareopelle done! says you need to click a confirmation link sent to your email.

[kaylareopelle]

With help from @simi and @hibachrach, opentelemetry-ruby is now a co-owner of the gRPC gem! 🎉 That should mean our release process has the permission it needs to publish a new version of the gem with its current versioning.

With this in mind, @arielvalentin, are you comfortable putting the previous entries back into the changelog? Will that work with toys? The only change I recommend is to take out the 2.0.0 entry and let toys take care of that when the release workflow runs.

[kaylareopelle]

@michal-kazmierczak - Two more small housekeeping changes and then we can merge this in!

[kaylareopelle]

@michal-kazmierczak - Could you add the CHANGELOG information back from version 0.1.3 and below? We're now set up to release the next version of the gem in step with the existing versioning and would like to maintain the README.

[michal-kazmierczak]

Sure, the CHANGELOG is restored up to v0.1.3