doc-mdbook.yml

# Build doc with mdBook and json-schema-for-humans
# See:
# - https://github.com/actions/starter-workflows/blob/main/pages/mdbook.yml
# - https://coveooss.github.io/json-schema-for-humans/#/
name: GitHub Pages with mdBook

on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch: 

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:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v1
        with:
          mdbook-version: '0.4.21'
        
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3

      - name: build mdBook site
        run: mdbook build ./docs/
      
      # A bit hacky as it modified directly mdbook folder
      - name: copy json schema doc into book
        run: cp docs/schema/index.html docs/book/config/schema.html

      - name: Upload mdBook artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./docs/book
  
  deploy:
    if: github.ref == 'refs/heads/main'
    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