Skip to content

Improve Initial Gem Release Process #1373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arielvalentin opened this issue Jan 29, 2025 · 2 comments
Open

Improve Initial Gem Release Process #1373

arielvalentin opened this issue Jan 29, 2025 · 2 comments
Labels
keep Ensures stale-bot keeps this issue/PR open

Comments

@arielvalentin
Copy link
Collaborator

arielvalentin commented Jan 29, 2025

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 #1313 (comment)

@kaylareopelle
Copy link
Contributor

kaylareopelle commented Jan 29, 2025

Is there something we could add to the instrumentation generator? Maybe a comment? Or something in the output along with the CI warning?

Copy link
Contributor

github-actions bot commented Mar 1, 2025

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label Mar 1, 2025
@kaylareopelle kaylareopelle added keep Ensures stale-bot keeps this issue/PR open and removed stale Marks an issue/PR stale labels Mar 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keep Ensures stale-bot keeps this issue/PR open
Projects
None yet
Development

No branches or pull requests

2 participants