docs.yml

name: Docs
# Docs build and publishes the Vuepress documentation website.
# This workflow is run on every pull request and push on master.
# The deployment of the docs is made only on each push on master.
on:
  pull_request:
  push:
    branches:
      - master

jobs:
  Markdown-Link-Check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@master
      - name: Checking docs 🔍
        uses: gaurav-nelson/github-action-markdown-link-check@v1
        with:
          use-quiet-mode: "yes"
          folder-path: "docs"
          config-file: "mlc_config.json"

  Build-and-Deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v2
        with:
          persist-credentials: false

      - name: Build 🔧
        run: |
          npm ci
          npm run build
          echo 'docs.bigdipper.live' > ./build/CNAME

      - name: Deploy 🚀
        if: github.event_name != 'pull_request'
        uses: JamesIves/github-pages-deploy-action@3.7.1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: ./build