Skip to content

fix docs (#218)

fix docs (#218) #146

Workflow file for this run

name: Deploy Jekyll site to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
submodules: "true"
- name: Setup Ruby
uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
with:
ruby-version: '2.7.6' # Not needed with a .ruby-version file
bundler: '2.4.10'
bundler-cache: false # runs 'bundle install' and caches installed gems automatically
cache-version: 3 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Update RubyGems and Co
run: gem update --system
- name: Install Ruby Bundles
run: bundle install
- name: Build with Jekyll
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --config '_config.yml' --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Build 2.x with Jekyll
# Outputs to the './_site' directory by default
run: |
cd .submodules/wiremock.org-2.x
bundle exec jekyll build --config '../../_config.yml,../../_config-2.x.yml' --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Build 3.x with Jekyll
# We use the same as the root build, but with additional config
run: |
bundle exec jekyll build --config '_config.yml,_config-3.x.yml' --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Deploy version branches to the website
run: |
ruby .scripts/merge-sitemaps.rb
mkdir _site/2.x
cp -R .submodules/wiremock.org-2.x/tmp/site_2x/* _site/2.x/
mkdir _site/3.x
cp -R tmp/site_3x/* _site/3.x/
# TODO: Uncomment when cleaned up (if ever)
# - name: Validate HTML and links
# uses: anishathalye/proof-html@v2
# with:
# directory: ./_site
# enforce_https: false
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v1
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2