Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Test docs with Proofer #2311

Closed
wants to merge 37 commits into from

2 participants

@penibelst

Second attemp for #2088. I hope

NOKOGIRI_USE_SYSTEM_LIBRARIES=true

does the trick.

site/_posts/2014-05-05-jekyll-2-0-0-released.markdown
@@ -28,4 +28,4 @@ Happy developing!
[changelog]: /docs/history/
[@jglovier]: https://github.com/jglovier
-[jekyll-1]: {% post_url 2013-05-05-jekyll-1-0-0-released %}
+[jekyll-1]: {% post_url 2013-05-06-jekyll-1-0-0-released %}
@parkr Owner
parkr added a note

This works with the previous URL: http://jekyllrb.com/news/2014/05/06/jekyll-turns-2-0-0/

ATM it's timezone-specific because safe_yaml pre-1.0 was weird about timezones.

I thought the argument must be post’s file name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@parkr
Owner

Merge conflict :crying_cat_face: Would you mind a quick rebase?

@parkr
Owner

Our total build time is averaging 13-17 minutes. This PR brings that up to 31 minutes. Can we do this another way? I don't want to have to wait 30 minutes to know whether I can merge a PR...

@penibelst

I don't want to have to wait 30 minutes to know whether I can merge a PR...

30 minutes is too much. What about moving the proofer test to the gh-pages branch only? Does Travis allow this?

@penibelst

Another option is to use one gemfile for regular tests, and one gemfile for docs test with latest released Jekyll only. Travis says:

For Ruby projects, env, rvm, gemfile, and jdk can be given as arrays to construct a build matrix.

@parkr
Owner

Can we run the docs check in the latest ruby version, but still check jekyll's unit/integration tests in 1.9.3, 2.0.0, and 2.1?

@penibelst

Can we run the docs check in the latest ruby version, but still check jekyll's unit/integration tests in 1.9.3, 2.0.0, and 2.1?

I think so. I’ll update the pull request.

@penibelst

Can we run the docs check in the latest ruby version, but still check jekyll's unit/integration tests in 1.9.3, 2.0.0, and 2.1?

The matrix is ready. I have an issue to build the docs: https://travis-ci.org/jekyll/jekyll/jobs/24838766 Can @jekyll/owners please investigate?

@parkr
Owner

add exclude: [vendor] to the _config.yml and try again!

@penibelst

@parkr Exclude does the trick.

@penibelst

Look at the results. The site test

  1. is shorter than the integration test;
  2. is allowed to fail;
  3. runs on the latest stable Ruby and Jekyll.
@penibelst

With NOKOGIRI_USE_SYSTEM_LIBRARIES=true the docs test takes only 2:43.

@penibelst

I think it’s done. The Rebund logic can be improved according to the env variable, but I don’t know how Rebund works.

.travis.yml
@@ -7,7 +7,7 @@ rvm:
- 2.1.1
- 2.0.0
- 1.9.3
-script: script/cibuild
+script: if [[ "$SITE" == true ]]; then script/proofer; else script/cibuild; fi
@parkr Owner
parkr added a note

Hm, could we do this in script/cibuild instead? Feels weird to have it here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@parkr
Owner

Let's also add a timezone to the _config.yml. Maybe try America/New_York? Should streamline it for everyone :)

@penibelst

Everything is done.

script/cibuild
((5 lines not shown))
script/branding
-bundle exec rake
+if [ "$SITE" ]; then
+ cd ./site
+ bundle exec jekyll build --trace
+ bundle exec htmlproof ./_site
+else
+ bundle exec rake
+fi
+
+
@parkr Owner
parkr added a note

Can you remove this extra space, please? :)

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
site/_config.yml
((4 lines not shown))
permalink: /news/:year/:month/:day/:title/
excerpt_separator: noifniof3nioaniof3nioafafinoafnoif
+exclude: [vendor]
+timezone: Europe/London
@parkr Owner
parkr added a note

Why did you choose this timezone?

It is about a London lawyer named Gabriel John Utterson who investigates strange occurrences between his old friend, Dr. Henry Jekyll, and the evil Edward Hyde.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@penibelst

@parkr Do you still have any performance concerns? If tests run in parallel, the site test is the shortest one, so you don’t wait more than usual.

@penibelst

Low priority.

@penibelst penibelst closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on May 7, 2014
  1. @penibelst

    Add proofer script

    penibelst authored
  2. @penibelst

    Add site:test

    penibelst authored
  3. @penibelst
  4. @penibelst
  5. @penibelst
  6. @penibelst

    Revert "Add NOKOGIRI_USE_SYSTEM_LIBRARIES to Gemfile"

    penibelst authored
    This reverts commit ee5ba47dec08be9a760704d265c6b4c22e4b3d2b.
  7. @penibelst

    Revert "Fix link just to test the performance"

    penibelst authored
    This reverts commit 486cfa21a2b0089839b1f6a8b36ffaccc767ef90.
  8. @penibelst

    Add fast finish

    penibelst authored
  9. @penibelst

    Fix post name again

    penibelst authored
Commits on May 9, 2014
  1. @penibelst

    Add Gemfile to site

    penibelst authored
  2. @penibelst
  3. @penibelst
  4. @penibelst

    Revert "Add Gemfile to site"

    penibelst authored
    This reverts commit cb80933583902fd5a933e5d63c28a0c9fa0883a3.
  5. @penibelst

    Just build the site

    penibelst authored
  6. @penibelst

    Remove site test from Rake

    penibelst authored
  7. @penibelst

    Add Matrix include

    penibelst authored
  8. @penibelst

    Change env

    penibelst authored
  9. @penibelst

    Add Gemfile to site

    penibelst authored
  10. @penibelst

    Add conditionals

    penibelst authored
  11. @penibelst

    Allow failures for site

    penibelst authored
  12. @penibelst
  13. @penibelst

    Add bundle exec

    penibelst authored
  14. @penibelst

    Remove rake gem

    penibelst authored
Commits on May 10, 2014
  1. @penibelst

    Exclude vendor directory

    penibelst authored
  2. @penibelst

    Add htmlproof

    penibelst authored
  3. @penibelst

    Bundle exec everything

    penibelst authored
  4. @penibelst
  5. @penibelst

    Fix allow_failures

    penibelst authored
  6. @penibelst

    Use latest Ruby. Tradition

    penibelst authored
  7. @penibelst

    Revert url fix

    penibelst authored
  8. @penibelst

    Fail on first error

    penibelst authored
  9. @penibelst
  10. @penibelst

    Move proofer into cibuild

    penibelst authored
  11. @penibelst
  12. @penibelst

    Remove extra space

    penibelst authored
Commits on May 11, 2014
  1. @penibelst

    Remove time zone again

    penibelst authored
Commits on May 12, 2014
  1. @penibelst

    Move env to install

    penibelst authored
This page is out of date. Refresh to see the latest.
View
9 .travis.yml
@@ -1,6 +1,7 @@
language: ruby
cache: bundler
install:
+- export NOKOGIRI_USE_SYSTEM_LIBRARIES=true
- script/rebund download
- travis_retry bundle install --path vendor/bundle
rvm:
@@ -25,3 +26,11 @@ env:
global:
- secure: bt5nglPTdsc0N5fB1dOJz2WbM81dGpDuVD8PnhEsxgUfoo6xavhU4+pNrUADlSUqQ1aJrdU+MKW4x+JZ2ZnJS8vOpNzRymuMZSbFaljK4pgFGiKFgBdMKxVikvoYcxKCjLAl7NJZ11W6hUw+JtJScClDZwrJJAQB6I7Isp/LsdM=
- secure: Ym8nx7nbfGYGo47my92M+deJykaiMkdZdb615EO51liv/xy/0aQ919Jpfieugc9d3zVnm+zFGPbpv4YzRpsik6OlVBNa4lP+BnQ27ptf5YcLWD8Hksi7845WFLecXMoaTCoYer/TvYZsIWJb2nSDMH9qbfZhnd1YZKuvUpK0rEU=
+matrix:
+ include:
+ - rvm: 2.1.2
+ gemfile: site/Gemfile
+ env: SITE=true
+ allow_failures:
+ - env: SITE=true
+ fast_finish: true
View
10 script/cibuild
@@ -1,4 +1,12 @@
#! /bin/bash
+set -e
+
script/branding
-bundle exec rake
+if [ "$SITE" ]; then
+ cd ./site
+ bundle exec jekyll build --trace
+ bundle exec htmlproof ./_site
+else
+ bundle exec rake
+fi
View
6 site/Gemfile
@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+group :test do
+ gem 'jekyll'
+ gem 'html-proofer'
+end
View
5 site/_config.yml
@@ -1,8 +1,11 @@
highlighter: pygments
relative_permalinks: false
-gauges_id: 503c5af6613f5d0f19000027
permalink: /news/:year/:month/:day/:title/
excerpt_separator: noifniof3nioaniof3nioafafinoafnoif
+exclude: [vendor]
+
+# custom
+gauges_id: 503c5af6613f5d0f19000027
repository: https://github.com/jekyll/jekyll
help_url: https://github.com/jekyll/jekyll-help
google_analytics_id: UA-50755011-1
Something went wrong with that request. Please try again.