Deploying Your Gem To RubyGems

In the previous part, we created our first Ruby gem.

In this part, we will deploy that gem to the package repository RubyGems.

Source code can be found here

Prerequisites

Getting started

We will clone the project rspec-github-actions (if you haven't been keeping up with the previous work):

$ git clone https://github.com/okeeffed/rspec-github-actions.git
$ cd rspec-github-actions
# Checkout the starting point
$ git checkout 2-gemspec
copy

At this stage, our project is now ready to continue working on.

Logging into your RubyGems account

If you have not done so yet, we need to grab your credentials from RubyGems and save it to your computer:

$ curl -u <your-username> https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
# It will request a password
copy

Once your password has been provided, your credentials will be write to the ~/.gem/credentials file.

Pushing the gem

We can use the gem push command in order to deploy a gem.

In the terminal, run the following to push the gem:

$ gem push contrived_math-0.0.0.gem
Pushing gem to https://rubygems.org...
Successfully registered gem: contrived_math (0.0.0)
copy

We can see the list of Gems that we have deployed like so:

$ gem list -r contrived_math

*** REMOTE GEMS ***

contrived_math (0.0.0)
copy

Trialling our new gem

Let's create another subfolder example and initialize a new project with Bundler.

$ mkdir example
$ cd example

# Initialize a new project
$ bundle init

# Add our gem
$ bundle add contrived_math
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Using bundler 2.1.4
Using contrived_math 0.0.0

# Create a file to test it out
$ touch main.rb
copy

Inside of example/main.rb, add the following:

require 'contrived_math'

def main
  puts ContrivedMath.add(1, 2)
  puts ContrivedMath.subtract(2, 1)
end

main
copy

Assuming that you are still in the example folder, we can run our code like so:

# From example/
$ ruby main.rb
3
1
copy

It works!

Summary

Today's post demonstrated how to deploy your Ruby Gem to the RubyGems repository and demonstrated the usage of installation with Bundler in another example folder.

The next post in this series will look to automate the process as part of a GitHub Actions workflow.

Resources and further reading

Photo credit: rgaleria