.github/workflows/nixos-manual.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

name: NixOS manual checks

permissions: read-all

on:
  pull_request_target:
    branches-ignore:
      - 'release-**'
    paths:
      - 'nixos/**/*.xml'
      - 'nixos/**/*.md'

jobs:
  tests:
    runs-on: ubuntu-latest
    if: github.repository_owner == 'NixOS'
    steps:
    - uses: actions/checkout@v3
      with:
        # pull_request_target checks out the base branch by default
        ref: refs/pull/${{ github.event.pull_request.number }}/merge
    - uses: cachix/install-nix-action@v18
    - name: Check DocBook files generated from Markdown are consistent
      run: |
        nixos/doc/manual/md-to-db.sh
        git diff --exit-code || {
          echo
          echo 'Generated manual files are out of date.'
          echo 'Please run'
          echo
          echo '    nixos/doc/manual/md-to-db.sh'
          echo
          exit 1
        }