neovim-flake/.github/workflows/check-docs.yml

name: "Validate flake & check documentation"
on:
  pull_request:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - docs/**
jobs:
  flake-docs-check:
    name: Validate Flake Documentation
    runs-on: ubuntu-latest
    strategy:
      matrix:
        package:
          - docs
          - docs-html
          - docs-manpages
          - docs-json
    steps:
      - uses: easimon/maximize-build-space@v8
        with:
          overprovision-lvm: true
          remove-android: true
          remove-dotnet: true
          remove-haskell: true

      - uses: cachix/install-nix-action@v20
        with:
          extra_nix_config: |
            access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
            auto-optimise-store = true
            experimental-features = nix-command flakes
          nix_path: nixpkgs=channel:nixos-unstable

      - uses: actions/checkout@v4
        name: Checkout

      - name: Set default git branch (to reduce log spam)
        run: git config --global init.defaultBranch main

      - name: Validate Flake
        run: nix flake check

      - name: Build neovim-flake with default settings
        run: nix build .#${{ matrix.package }} --print-build-logs

      - name: Upload doc artifacts
        uses: actions/upload-artifact@v3
        with:
          name: doc
          path: result/share/doc/neovim-flake/