summary refs log tree commit diff
path: root/.github
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-09-03 16:35:28 +0200
committerpennae <82953136+pennae@users.noreply.github.com>2022-09-10 18:23:13 +0200
commitec75c8efff8eab18dc8ec7c5016d589c0c705f95 (patch)
treec8a852426c27579fa7d5290e60fa6e84c5c7a871 /.github
parentd98322834b496876723a529b92c2f80eeae0a60c (diff)
downloadnixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.tar
nixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.tar.gz
nixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.tar.bz2
nixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.tar.lz
nixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.tar.xz
nixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.tar.zst
nixpkgs-ec75c8efff8eab18dc8ec7c5016d589c0c705f95.zip
workflows: check that nixos manual does not use docbook option docs
the nixos manual should not use docbook for module option documentation,
only markdown, to make future transition to a markdown-only world easier
and less painful. this check will ensure that all options
documentation (even plain text that would not be interpreted specially
by neither markdown nor docbook) is declared as being markdown.
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/manual-nixos.yml10
1 files changed, 9 insertions, 1 deletions
diff --git a/.github/workflows/manual-nixos.yml b/.github/workflows/manual-nixos.yml
index 64829a19136..86825eb5aef 100644
--- a/.github/workflows/manual-nixos.yml
+++ b/.github/workflows/manual-nixos.yml
@@ -27,5 +27,13 @@ jobs:
           # This cache is for the nixpkgs repo checks and should not be trusted or used elsewhere.
           name: nixpkgs-ci
           signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
-      - name: Building NixOS manual
+      - name: Building NixOS manual with DocBook options
         run: NIX_PATH=nixpkgs=$(pwd) nix-build --option restrict-eval true nixos/release.nix -A manual.x86_64-linux
+      - name: Building NixOS manual with Markdown options
+        run: |
+          export NIX_PATH=nixpkgs=$(pwd)
+          nix-build \
+            --option restrict-eval true \
+            --arg configuration '{ documentation.nixos.options.allowDocBook = false; }' \
+            nixos/release.nix \
+            -A manual.x86_64-linux