[email protected]:msoe-sg/jekyll-github-pages-gem.git
cd jekyll-github-pages-gem
bundle install
To generate HTML documentation for the Gem run the command rake rdoc
and the HTML will then be available in the html/
directory in the project.
There are checks that will be performed whenever Pull Requests are opened. To save time on the build server, please run the tests locally to check for errors that will occur in the CI builds.
bundle exec rubocop
. Note the command bundle exec rubocop -a
will attempt to automatically fix any offenses found by rubocop but some still need to be resolved manually.rake
When the gem is released it's deployed to a https://rubygems.org project. The SSE webmaster controls the rubygems project and will handle releasing the gem to rubygems. The following commands below are used to release the gem if you have permissions to the rubygems project.
gem build jekyll_github_pages
gem push jekyll-github-pages-gem-<VERSION>.gem