name: Docs build
# This workflow runs when a PR is labeled with `docs`
# This will check if the docs build successfully by running `npm run build`
on:
  pull_request:
  push:
    branches:
      - main
      - release/*

jobs:
  check-docs-build:
    name: Check docs build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2.3.4
        with:
          persist-credentials: false
          fetch-depth: 0
      - uses: technote-space/get-diff-action@v5
        id: git_diff
        with:
          PATTERNS: |
            docs/*
          SUFFIX_FILTER: |
            .md
      - name: Install dependencies and build docs 🧱
        run: |
          make build-docs