Setup

1. Follow the instructions from the wiki article here to setup your development environment.
2. Open up a terminal to the folder where you want to clone the repo and run the command [email protected]:msoe-sg/jekyll-github-pages-gem.git
3. After run the clone change into the project directory by running the command cd jekyll-github-pages-gem
4. Next install the dependencies for the project by running the command bundle install
5. Contribute Our git flow process is typical--we have a master branch that gets released to the public, and feature branches for individual tasks. We don't have a development branch yet since this isn't used in production yet. If you have questions on how to contribute, please contact [email protected] or [email protected] and we will get back to you at our earliest convenience.

Generating HTML Documentation

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.

Continuous Integration

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.

1. To run Rubocop, run the command 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.
2. To run all unit tests, run the command rake

Releasing the Gem

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.

1. gem build jekyll_github_pages
2. gem push jekyll-github-pages-gem-<VERSION>.gem