mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-01 23:22:37 +00:00
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.
This commit is contained in:
parent
d98322834b
commit
ec75c8efff
10
.github/workflows/manual-nixos.yml
vendored
10
.github/workflows/manual-nixos.yml
vendored
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user