validate-docs.yml

name: Validate documentation

on:
  pull_request:
    paths:
      # existing docs
      - "docs/**"
      # changes to the cli reference generator
      - "docsgen/**"
      # potential changes to commands documentation
      - "cli/**"
      # changes to the workflow itself
      - ".github/workflows/validate-docs.yml"
  push:
    paths:
      - "docs/**"
      - "docsgen/**"
      - "cli/**"
      - "rpc/**"
      - ".github/workflows/validate-docs.yml"

jobs:
  validate:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout local repository
        uses: actions/checkout@v2

      - name: Install Taskfile
        uses: arduino/setup-task@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          version: 3.x

      - name: Install Go
        uses: actions/setup-go@v2
        with:
          go-version: "1.14"

      - name: Install Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"

      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('./pyproject.toml') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Install Poetry
        run: |
          python -m pip install --upgrade pip
          python -m pip install poetry

      - name: Build documentation website
        # Ensure the documentation can build. These docs won't be published.
        run: task docs:build