Merge branch 'development' of github.com:UtrechtUniversity/yoda into … #355
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation | |
on: | |
push: | |
branches: | |
- development | |
paths: | |
- 'docs/**' | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
# Cache Ruby dependencies across runs, in order to speed up jobs | |
- uses: actions/cache@v1 | |
with: | |
path: vendor/bundle | |
key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }} | |
restore-keys: | | |
${{ runner.os }}-gem- | |
- name: Set up Ruby 2.7 | |
uses: ruby/setup-ruby@v1 | |
with: | |
ruby-version: '2.7' | |
bundler-cache: true | |
- name: Install Jekyll dependencies | |
run: | | |
cd docs | |
gem install bundler --no-document | |
bundle config path vendor/bundle | |
bundle install --jobs 4 | |
- name: Build test site | |
run: | | |
cd docs | |
bundle exec jekyll build --config _config_test.yml | |
- name: Run basic HTML checks | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y libxslt-dev libxml2-dev zlib1g-dev | |
gem install html-proofer --no-document -v 3.19.4 | |
cd docs | |
htmlproofer _site --url-ignore "/#.*/" --disable-external | |
env: | |
NOKOGIRI_USE_SYSTEM_LIBRARIES: true | |
- name: Check external links with Linkchecker | |
run: | | |
sudo apt-get install -y linkchecker | |
echo -e "[checking]\nlocalwebroot=$(realpath _site)" > lc.config | |
cd docs | |
linkchecker -f lc.config _site | |
- name: Build production site | |
run: | | |
cd docs | |
rm -rf _site | |
bundle exec jekyll build --config _config_prod.yml | |
- name: Deploy 🚀 | |
uses: JamesIves/github-pages-deploy-action@releases/v3 | |
with: | |
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} | |
BRANCH: gh-pages | |
FOLDER: docs/_site |