README.md
<img src="/logo.svg" width="64px" height="64px"/>
[](http://www.rultor.com/p/yegor256/jekyll-github-deploy)
[](https://www.jetbrains.com/ruby/)
[](https://github.com/yegor256/jekyll-github-deploy/actions/workflows/rake.yml)
[](http://badge.fury.io/rb/jgd)
[](https://hitsofcode.com/view/github/yegor256/jekyll-github-deploy)
[](https://github.com/yegor256/jekyll-github-deploy/blob/master/LICENSE.txt)
If you use some plugins with your [Jekyll](https://jekyllrb.com/) blog, chances are you can not
have your blog generated by [GitHub Pages](https://pages.github.com/).
First of all, because they [do not allow](https://help.github.com/en/articles/adding-jekyll-plugins-to-a-github-pages-site)
custom plugins.
This is where jekyll-github-deploy (a.k.a. jgd) comes in: it will
automatically build your Jekyll blog and push it to your gh-pages
branch. You may want to read this blog post before you start
using this tool:
[_Deploy Jekyll to GitHub Pages_](https://www.yegor256.com/2014/06/24/jekyll-github-deploy.html).
It is assumed that your blog is in the home directory of your repo.
Install it first:
```bash
$ gem install jgd
```
Run it locally:
```bash
$ jgd
```
Now your site is deployed to `gh-pages` branch of your repo. Done.
Below is a list of all command line options.
| Option | Description |
| -------- | ----------- |
| `-u` or `--url` | The GitHub URL. Defaults to th URL of your current project. |
| `-b` or `--branch` | The branch to push your site to. Defaults to `gh-pages`. If the branch does not exist, it will be created. |
| `-r` or `--branch-from` | The source branch. Defaults to `master`. |
| `-c` or `--config` | Name of the optional deploy config file. See [Production variables](#production-variables) below for more information. |
| `-d` or `--drafts` | Adds the `--drafts` option to Jekyll so that it will build draft posts. |
| `-h` or `--help` | Displays a list of all options. |
If you need to have different values for your deployed blog, just add a
`_config-deploy.yml` file in your project's root and you're set. Values
re-defined in `_config-deploy.yml` will override those defined in
`_config.yml`.
Typical usage includes changing site `url`, disable disqus or ga in
development...., you name it.
While `_config-deploy.yml` is the default, you may specify any config
file by using the `--config` command line option.
For example:
```sh
$ jgd -c _config-deploy-develop.yml -r develop -b gh-pages-develop
```
## Deploying with Travis
This is how I configure [my Jekyll blog](https://github.com/yegor256/blog)
to be deployed automatically by [travis-ci](http://www.travis-ci.org):
```yaml
branches:
only:
- master
env:
global:
- secure: ...
install:
- bundle
script: jgd -u http://yegor256:$PASSWORD@github.com/yegor256/blog.git
```
The environment variable `$PASSWORD` is set through
`env/global/secure`, as explained
[here](http://docs.travis-ci.com/user/encryption-keys/).
Don't forget to add `gem require 'jgd'` to your `Gemfile`.
You can use SSH key instead. First, you should [encrypt](https://docs.travis-ci.com/user/encrypting-files/) it:
```bash
$ travis encrypt-file id_rsa --add
```
Then, use the URI that starts with `git@`:
```yaml
script:
- jgd -u git@github.com:yegor256/blog.git
```
## Building locally
In order to build a package locally run below commands.
```bash
gem build jgd.gemspec
gem install jgd-<version>.gem
```
## How to Contribute
First, install
[Ruby 2.3+](https://www.ruby-lang.org/en/documentation/installation/),
[Rubygems](https://rubygems.org/pages/download),
and
[Bundler](https://bundler.io/).
Then:
```bash
$ bundle update
$ bundle exec rake --quiet
$ ./tesh.sh
```
The build has to be clean. If it's not, [submit an issue](https://github.com/zold-io/out/issues).
Then, make your changes, make sure the build is still clean,
and [submit a pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).