open-telemetry/opentelemetry-ruby-contrib

Improve Initial Gem Release Process

Open

#1,373 opened on Jan 29, 2025

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Ruby (252 forks)auto 404
help wantedkeep

Repository metrics

Stars
 (135 stars)
PR merge metrics
 (PR metrics pending)

Description

We tend to have the same mistakes repeated when releasing new gems. I think we need a linter or guide to help us avoid them in the future.

Our automated release tooling handles versioning. For initial releases this should have been set to 0.0.0

The instrumentation generator seeds the version here:

https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.instrumentation_generator/templates/lib/instrumentation/instrumentation_name/version.rb.tt#L10

That along with the empty CHANGELOG signals to the release tooling that this specific version will need to be an "initial release" of the gem https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.instrumentation_generator/templates/CHANGELOG.md.tt

Originally posted by @arielvalentin in https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1313#discussion_r1933999091

Contributor guide

Research direction
Examine the linked PR discussion and the instrumentation generator templates to understand the release process gaps, then propose a linter or guide to standardize initial gem versions and CHANGELOG.
Tech stack
ruby
Domain
developer experiencetooling
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RubyGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60