open-telemetry/opentelemetry-ruby-contrib

Improve Initial Gem Release Process

Aberta

#1.373 aberto em 29 de jan. de 2025

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)Ruby (252 forks)auto 404
help wantedkeep

Métricas do repositório

Stars
 (135 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Examine a discussão do PR vinculado e os modelos do gerador de instrumentação para entender as lacunas no processo de lançamento, depois proponha um linter ou guia para padronizar versões iniciais de gems e CHANGELOG.
Pilha de tecnologia
ruby
Domain
developer experiencetooling
Tipo Issue
Manutenção
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RubyGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60