Skip to content

update api doc

update api doc #407

Workflow file for this run

name: Build & Deploy
on:
push:
branches: ["gh_pages"]
pull_request:
branches: ["gh_pages"]
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages-${{ github.ref }}"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 20 #fetch the last 20 commits to get mtimes from
lfs: true
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
bundler-cache: true
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: restore files mtime
run: |
sudo apt -qqy update
sudo apt -qqy install git-restore-mtime
git restore-mtime
- name: Build with Jekyll
run: bundle exec jekyll build
env:
JEKYLL_ENV: production
- name: test HTML validity
run: >
bundle exec htmlproofer _site/
--disable-external true
--enforce-https false
--allow-missing-href=true
--log-level :debug
- name: Upload artifact
if: ${{ github.ref == 'refs/heads/gh_pages' }}
uses: actions/upload-pages-artifact@v1
# Deployment job
deploy:
if: ${{ github.ref == 'refs/heads/gh_pages' }}
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@v1