From 64050cf3474adb8705991f8e3a0e2fd36bf5dcd4 Mon Sep 17 00:00:00 2001
From: Sebastian Kunert <skunert49@gmail.com>
Date: Fri, 23 Feb 2024 14:04:10 +0100
Subject: [PATCH] prdoc: Print errors on CI (#3459)
By passing `RUST_LOG=info` to the check command, we will be able to see
the exact problem with a given prdoc.
Before:
```
PR #3243 -> ERR
```
After:
```
[2024-02-23T12:53:55Z INFO prdoclib::commands::check] Checking directory prdoc
[2024-02-23T12:53:55Z INFO prdoclib::commands::check] Using schema: /Users/sebastian/work/repos/polkadot-sdk/prdoc/schema_user.json
[2024-02-23T12:53:55Z WARN prdoclib::schema] validation_result: false
[2024-02-23T12:53:55Z WARN prdoclib::schema] validation_result_strict: false
[2024-02-23T12:53:55Z WARN prdoclib::schema] errors: [
Required {
path: "/title",
},
]
[2024-02-23T12:53:55Z WARN prdoclib::schema] missing: []
[2024-02-23T12:53:55Z ERROR prdoclib::commands::check] Loading the schema failed:
[2024-02-23T12:53:55Z ERROR prdoclib::commands::check] ValidationErrors(ValidationState { errors: [Required { path: "/title" }], missing: [], replacement: None, evaluated: {"/doc/0/description", "/crates/0/name", "/doc/0", "/crates", "/crates/0", "", "/doc", "/doc/0/audience"} })
PR #3243 -> ERR
```
---
.github/workflows/check-prdoc.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/check-prdoc.yml b/.github/workflows/check-prdoc.yml
index 5503b61d681..91701ca036e 100644
--- a/.github/workflows/check-prdoc.yml
+++ b/.github/workflows/check-prdoc.yml
@@ -56,4 +56,4 @@ jobs:
run: |
echo "Checking for PR#${GITHUB_PR}"
echo "You can find more information about PRDoc at $PRDOC_DOC"
- $ENGINE run --rm -v $PWD:/repo $IMAGE check -n ${GITHUB_PR}
+ $ENGINE run --rm -v $PWD:/repo -e RUST_LOG=info $IMAGE check -n ${GITHUB_PR}
--
GitLab