open-telemetry/opentelemetry-ruby-contrib

Improve Initial Gem Release Process

Ouverte

#1 373 ouverte le 29 janv. 2025

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Ruby (252 forks)auto 404
help wantedkeep

Métriques du dépôt

Stars
 (135 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez la discussion du PR lié et les modèles du générateur d'instrumentation pour comprendre les lacunes du processus de publication, puis proposez un linter ou un guide pour normaliser les versions initiales des gems et le CHANGELOG.
Stack technique
ruby
Domaine
developer experiencetooling
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RubyGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60