Skip to content

RELEASING.md

Latest commit

 

History

History
83 lines (55 loc) · 1.34 KB

RELEASING.md

File metadata and controls

83 lines (55 loc) · 1.34 KB

Releasing

This guide explains how to release a new version of the uptrace-ruby gem to RubyGems.

Install Ruby

On Ubuntu, install Ruby with rbenv:

git clone https://github.com/rbenv/rbenv.git ~/.rbenv
git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
rbenv init
rbenv install -l
rbenv install 3.4.8
rbenv global 3.4.8

Managing Dependencies

Checking for outdated dependencies

To view outdated dependencies:

bundle outdated

Updating dependencies

Edit the Gemfile to update dependency versions, then update the Gemfile.lock:

bundle update

Installing dependencies

To install all dependencies:

bundle install

Running Tests

Before releasing, ensure all tests pass:

rake test

Running linter

To run linter:

bundle exec rake

To auto-correct issues:

bundle exec rubocop -A

Publishing a Release

  1. Update the version: Bump the version number in lib/uptrace/version.rb

  2. Build and publish the gem:

    gem build uptrace.gemspec
bundle install
gem push uptrace-X.Y.Z.gem

    Replace X.Y.Z with the actual version number you specified in step 1.

Note: Make sure you have the necessary permissions to push to the uptrace gem on RubyGems before attempting to publish.