From 3e92097adb4e061668ac89618d1f725ab223a9ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <deso@posteo.net>
Date: Tue, 15 Nov 2022 07:43:58 -0800
Subject: [PATCH] Deny warnings when generating documentation in CI

Our cargo doc invocation in CI is expected to fail when detecting
issues. However, given the way it is invoked currently, it is more
likely to emit warnings instead. Obviously, those may go undetected for
a long time.
To fix this issue, this change makes sure to set the RUSTDOCFLAGS in
such a way that cargo doc denies any warnings, converting them to errors
instead.
---
 .github/workflows/ci.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index edad6080..aa2b1e52 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -81,6 +81,8 @@ jobs:
   cargo-doc:
     name: Generate documentation
     runs-on: ubuntu-latest
+    env:
+      RUSTDOCFLAGS: '-D warnings'
     steps:
       - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1