dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Review CI pages

This commit is contained in:
Frank Taillandier 2017-01-24 01:42:53 +01:00
parent 3a3ceff150
commit aefec6654d
6 changed files with 19 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/_docs/continuous-integration.md
View File

@ -1,20 +0,0 @@
---
title: Continuous Integration
---
Continuous Integration (CI) enables you to publish your Jekyll generated website with confidence by automating the quality assurance and deployment processes. You can quickly get started using CI with one of the providers below:
<div style="display:flex;flex-wrap:wrap;">
<div style="width:49%;text-align:center;">
<a href="travis-ci/">
<img src="{{site.baseurl}}/img/travis-ci-badge.png" style="width:70%;" />
<h2>Travis CI</h2>
</a>
</div>
<div style="width:49%;text-align:center;">
<a href="circleci/">
<img src="{{site.baseurl}}/img/circleci-badge.svg" style="width:70%;" />
<h2>CircleCI</h2>
</a>
</div>
</div>

6
docs/_docs/continuous-integration/circleci.md
View File

@ -8,7 +8,7 @@ Building, testing, and deploying your Jekyll-generated website can quickly be do
[1]: https://github.com/ [1]: https://github.com/
[2]: https://bitbucket.org/ [2]: https://bitbucket.org/
## Follow Your Project on CircleCI ## 1. Follow Your Project on CircleCI
To start building your project on CircleCI, all you need to do is 'follow' your project from CircleCI's website: To start building your project on CircleCI, all you need to do is 'follow' your project from CircleCI's website:
@ -19,7 +19,7 @@ To start building your project on CircleCI, all you need to do is 'follow' your
[3]: https://circleci.com/docs/configuration/ [3]: https://circleci.com/docs/configuration/
## Dependencies ## 2. Dependencies
The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a [Gemfile][4]. You'd want to have Jekyll, any Jekyll plugins, [HTML Proofer](#html-proofer), and any other gems that you are using in the `Gemfile`. Don't forget to version `Gemfile.lock` as well. Here's an example `Gemfile`: The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a [Gemfile][4]. You'd want to have Jekyll, any Jekyll plugins, [HTML Proofer](#html-proofer), and any other gems that you are using in the `Gemfile`. Don't forget to version `Gemfile.lock` as well. Here's an example `Gemfile`:
@ -36,7 +36,7 @@ gem 'html-proofer'
CircleCI detects when `Gemfile` is present is will automatically run `bundle install` for you in the `dependencies` phase. CircleCI detects when `Gemfile` is present is will automatically run `bundle install` for you in the `dependencies` phase.
## Testing ## 3. Testing
The most basic test that can be run is simply seeing if `jekyll build` actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we'll run Jekyll, via Bundler, in the `dependencies` phase. The most basic test that can be run is simply seeing if `jekyll build` actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we'll run Jekyll, via Bundler, in the `dependencies` phase.

9
docs/_docs/continuous-integration/index.md Normal file
View File

@ -0,0 +1,9 @@
---
title: Continuous Integration
permalink: /docs/continuous-integration/
---
Continuous Integration (CI) enables you to publish your Jekyll generated website with confidence by automating the quality assurance and deployment processes. You can quickly get started using CI with one of the providers below:
* [Travis CI](travis-ci)
* [CircleCI](circleci)

14
docs/_docs/continuous-integration/travis-ci.md
View File

@ -4,10 +4,10 @@ title: "Travis CI"
You can easily test your website build against one or more versions of Ruby. You can easily test your website build against one or more versions of Ruby.
The following guide will show you how to set up a free build environment on The following guide will show you how to set up a free build environment on
[Travis][0], with [GitHub][1] integration for pull requests. [Travis][travis], with [GitHub][github] integration for pull requests.
[0]: https://travis-ci.org/ [travis]: https://travis-ci.org/
[1]: https://github.com/ [github]: https://github.com/
## 1. Enabling Travis and GitHub ## 1. Enabling Travis and GitHub
@ -26,7 +26,7 @@ The simplest test script simply runs `jekyll build` and ensures that Jekyll
doesn't fail to build the site. It doesn't check the resulting site, but it doesn't fail to build the site. It doesn't check the resulting site, but it
does ensure things are built properly. does ensure things are built properly.
When testing Jekyll output, there is no better tool than [html-proofer][2]. When testing Jekyll output, there is no better tool than [html-proofer][html-proofer].
This tool checks your resulting site to ensure all links and images exist. This tool checks your resulting site to ensure all links and images exist.
Utilize it either with the convenient `htmlproofer` command-line executable, Utilize it either with the convenient `htmlproofer` command-line executable,
or write a Ruby script which utilizes the gem. or write a Ruby script which utilizes the gem.
@ -68,7 +68,7 @@ Options are given as a second argument to `.new`, and are encoded in a
symbol-keyed Ruby Hash. For more information about the configuration options, symbol-keyed Ruby Hash. For more information about the configuration options,
check out `html-proofer`'s README file. check out `html-proofer`'s README file.
[2]: https://github.com/gjtorikian/html-proofer [html-proofer]: https://github.com/gjtorikian/html-proofer
## 3. Configuring Your Travis Builds ## 3. Configuring Your Travis Builds
@ -91,7 +91,7 @@ Your `.travis.yml` file should look like this:
```yaml ```yaml
language: ruby language: ruby
rvm: rvm:
- 2.2.5 - 2.3.3
before_script: before_script:
- chmod +x ./script/cibuild # or do this locally and commit - chmod +x ./script/cibuild # or do this locally and commit
@ -124,7 +124,7 @@ access to Bundler, RubyGems, and a Ruby runtime.
```yaml ```yaml
rvm: rvm:
- 2.2.5 - 2.3.3
``` ```
RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This

14
docs/img/circleci-badge.svg
View File

@ -1,14 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 19.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
<rect x="-3850" y="-1178" display="none" fill="#FFFFFF" width="700" height="700"/>
<g>
<path id="mark_1_" fill="#FFFFFF" d="M373.4,500c0-65.8,53.3-119.1,119.1-119.1c65.7,0,119,53.3,119,119.1c0,65.7-53.3,119-119,119
C426.8,619,373.4,565.7,373.4,500z M492.5,0C259.1,0,63.3,159.9,8.1,376.1c-0.4,1.6-0.6,3.2-0.6,4.8c0,13.2,10.7,23.8,23.8,23.8
h201.5c9.6,0,17.8-5.7,21.6-13.9l0.1,0c41.4-90.1,132.4-152.8,238-152.8c144.6,0,261.9,117.3,261.9,261.9
c0,144.6-117.3,261.9-261.9,261.9c-105.7,0-196.7-62.6-238-152.8l-0.1,0c-3.8-8.2-12-13.9-21.6-13.9H31.3
c-13.1,0-23.8,10.7-23.8,23.8c0,1.6,0.3,3.2,0.6,4.8C63.2,840,259.1,1000,492.5,1000c276.1,0,500-223.9,500-500
C992.5,223.9,768.6,0,492.5,0z"/>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 1.0 KiB

BIN
docs/img/travis-ci-badge.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 26 KiB