alioth/nixpkgs
3
0
Fork 0
forked from mirrors/nixpkgs
Code Releases Activity
nixpkgs/.github/workflows/manual-rendering.yml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

65 lines
2.2 KiB
YAML
Raw Normal View History

workflows: add check for docbook/md manual equality we want to make sure that rendering the manual from markdown without going through docbook produces (semantically) the same output as with going through docbook. to ensure this we'll build the manual twice, run each manual through html-tidy to generate a normalized form and diff the normalized forms. we don't want to compare raw output because that exposes us to a lot of whitespace we'd have to reproduce exactly in the MD render. this check may be relaxed even further in the future, but hopefully not by much.
2022-09-03 15:35:28 +01:00
name: "Check NixOS Manual DocBook rendering against MD rendering"
on:
schedule:
# * is a special character in YAML so you have to quote this string
# Check every 24 hours
- cron: '0 0 * * *'
permissions:
contents: read
jobs:
check-rendering-equivalence:
permissions:
.github/workflows: fix permissions the merge actions comment on pull requests, seems this was broken by 2c71278a2395d6d8c4e06d1ebe4de1ffdae727c7 also: - fix permissions on new manual rendering action - drop unnecessary issues permission from the terraform action
2022-09-11 08:01:47 +01:00
pull-requests: write # for peter-evans/create-or-update-comment to create or update comment
workflows: add check for docbook/md manual equality we want to make sure that rendering the manual from markdown without going through docbook produces (semantically) the same output as with going through docbook. to ensure this we'll build the manual twice, run each manual through html-tidy to generate a normalized form and diff the normalized forms. we don't want to compare raw output because that exposes us to a lot of whitespace we'd have to reproduce exactly in the MD render. this check may be relaxed even further in the future, but hopefully not by much.
2022-09-03 15:35:28 +01:00
if: github.repository_owner == 'NixOS'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
build(deps): bump cachix/install-nix-action from 17 to 18 Bumps [cachix/install-nix-action](https://github.com/cachix/install-nix-action) from 17 to 18. - [Release notes](https://github.com/cachix/install-nix-action/releases) - [Commits](https://github.com/cachix/install-nix-action/compare/v17...v18)
2022-10-13 00:12:03 +01:00
- uses: cachix/install-nix-action@v18
workflows: add check for docbook/md manual equality we want to make sure that rendering the manual from markdown without going through docbook produces (semantically) the same output as with going through docbook. to ensure this we'll build the manual twice, run each manual through html-tidy to generate a normalized form and diff the normalized forms. we don't want to compare raw output because that exposes us to a lot of whitespace we'd have to reproduce exactly in the MD render. this check may be relaxed even further in the future, but hopefully not by much.
2022-09-03 15:35:28 +01:00
with:
# explicitly enable sandbox
extra_nix_config: sandbox = true
build(deps): bump cachix/cachix-action from 10 to 11 Bumps [cachix/cachix-action](https://github.com/cachix/cachix-action) from 10 to 11. - [Release notes](https://github.com/cachix/cachix-action/releases) - [Commits](https://github.com/cachix/cachix-action/compare/v10...v11)
2022-10-13 00:12:00 +01:00
- uses: cachix/cachix-action@v11
workflows: add check for docbook/md manual equality we want to make sure that rendering the manual from markdown without going through docbook produces (semantically) the same output as with going through docbook. to ensure this we'll build the manual twice, run each manual through html-tidy to generate a normalized form and diff the normalized forms. we don't want to compare raw output because that exposes us to a lot of whitespace we'd have to reproduce exactly in the MD render. this check may be relaxed even further in the future, but hopefully not by much.
2022-09-03 15:35:28 +01:00
with:
# 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: Build DocBook and MD manuals
run: |
export NIX_PATH=nixpkgs=$(pwd)
nix-build \
--option restrict-eval true \
-o docbook nixos/release.nix \
-A manual.x86_64-linux
nix-build \
--option restrict-eval true \
--arg configuration '{ documentation.nixos.options.allowDocBook = false; }' \
-o md nixos/release.nix \
-A manual.x86_64-linux
- name: Compare DocBook and MD manuals
id: check
run: |
workflows: fix manual-rendering.yml the check command didn't set NIX_PATH, so compare-manuals.sh (which is a nix-shell script) failed.
2022-09-11 02:08:01 +01:00
export NIX_PATH=nixpkgs=$(pwd)
workflows: add check for docbook/md manual equality we want to make sure that rendering the manual from markdown without going through docbook produces (semantically) the same output as with going through docbook. to ensure this we'll build the manual twice, run each manual through html-tidy to generate a normalized form and diff the normalized forms. we don't want to compare raw output because that exposes us to a lot of whitespace we'd have to reproduce exactly in the MD render. this check may be relaxed even further in the future, but hopefully not by much.
2022-09-03 15:35:28 +01:00
.github/workflows/compare-manuals.sh \
docbook/share/doc/nixos/options.html \
md/share/doc/nixos/options.html
# if the manual can't be built we don't want to notify anyone.
# while this may temporarily hide rendering failures it will be a lot
# less noisy until all nixpkgs pull requests have stopped using
# docbook for option docs.
- name: Comment on failure
uses: peter-evans/create-or-update-comment@v2
if: ${{ failure() && steps.check.conclusion == 'failure' }}
with:
issue-number: 189318
body: |
Markdown and DocBook manuals do not agree.
Check https://github.com/NixOS/nixpkgs/actions/runs/${{ github.run_id }} for details.
Copy permalink