jekyll-github-deploy - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #go #docker #java #kubernetes #vue #security #pytorch #ios #mcp #open-source

jekyll-github-deploy

(★ 83)

Jekyll Site Automated Deployer to GitHub Pages

파일 탐색기

최종 버전 다운로드 (.zip)

- - actionlint.yml
  - bashate.yml
  - copyrights.yml
  - markdown-lint.yml
  - pdd.yml
  - rake.yml
  - reuse.yml
  - shellcheck.yml
  - typos.yml
  - xcop.yml
  - yamllint.yml
- deploy.sh
- jgd
- MIT.txt
.0pdd.yml
.gitignore
.pdd
.rubocop.yml
.rultor.yml
Gemfile
jgd.gemspec
LICENSE.txt
logo.svg
Rakefile
README.md
renovate.json
REUSE.toml
rubygems.yml.asc
test.sh

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/yegor256/jekyll-github-deploy

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd jekyll-github-deploy

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Ruby gem 명령어를 쓰려면 Ruby가 필요합니다.

gem install jgd-<version>.gem

RubyGems에 배포된 패키지를 바로 설치합니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Ruby

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

- bundle

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ bundle update

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ bundle exec rake --quiet

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img src="/logo.svg" width="64px" height="64px"/>

[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/jekyll-github-deploy)](https://www.rultor.com/p/yegor256/jekyll-github-deploy)
[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)

[![rake](https://github.com/yegor256/jekyll-github-deploy/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/jekyll-github-deploy/actions/workflows/rake.yml)
[![Gem Version](https://badge.fury.io/rb/jgd.svg)](https://badge.fury.io/rb/jgd)
[![Hits-of-Code](https://hitsofcode.com/github/yegor256/jekyll-github-deploy)](https://hitsofcode.com/view/github/yegor256/jekyll-github-deploy)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](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).