semantic-release-rubygem
Advanced tools
Weekly downloads
Changelog
Readme
semantic-release plugin for publishing Ruby gems.
Step | Description | |
---|---|---|
verifyConditions | Locate and validate a .gemspec file, locate and validate a lib/**/version.rb file, verify the presence of the GEM_HOST_API_KEY environment variable, and create a credentials file with the API key. | |
prepare | Update the version in the lib/**/version.rb version file and build the gem. | |
publish | Push the gem to the gem server. |
$ npm install semantic-release-rubygem -D
Add the plugin to the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"semantic-release-rubygem",
]
}
The gem server authentication configuration is required.
The API key must be set using the GEM_HOST_API_KEY
environment variable. To retrieve the key, you can:
gem signin
command. After you enter your credentials, your API key will be stored as a YAML value in the ~/.gem/credentials
file under the rubygems_api_key
key (or the hostname of your gem server).This plugin requires exactly one valid .gemspec
file to be present in the CWD.
lib/**/version.rb
fileThis plugin requires the version of the published gem to be defined in a version.rb
file somewhere in the lib
folder (e.g. lib/my/gem/version.rb
). The version itself must be defined as a constant named VERSION
inside the file:
module My
module Gem
VERSION = '0.0.0'
end
end
Options | Description | Default |
---|---|---|
gemHost | The gem server to push the gem to. | 'https//rubygems.org' |
updateGemfileLock | Whether to update the version of the gem to publish in the Gemfile.lock . This is useful if you are using the @semantic-release/git plugin to keep the version up to date in your git repo. When set to true the plugin will run bundle install to update the version. If another command is desired, it can be set by passing a string (e.g. bundle appraisal install ). | false |
gemPublish | Whether to publish your gem to the gem server. | true |
gemFileDir | Directory path in which to write the the built .gem file. If false , the .gem file will not be kept on the file system. | false |
FAQs
A semantic-release plugin for publishing Ruby gems
The npm package semantic-release-rubygem receives a total of 638 weekly downloads. As such, semantic-release-rubygem popularity was classified as not popular.
We found that semantic-release-rubygem demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.