From 9c4413dd9e57207e14763dd448229f2c7df6e91e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Mon, 7 Jun 2021 16:36:48 +0200 Subject: [PATCH] tpl/fmt: Add erroridf template func Fixes #8613 --- content/en/functions/errorf.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/content/en/functions/errorf.md b/content/en/functions/errorf.md index 450e92679..a20ad4f44 100644 --- a/content/en/functions/errorf.md +++ b/content/en/functions/errorf.md @@ -31,3 +31,22 @@ Both functions return an empty string, so the messages are only printed to the c ``` Note that `errorf` and `warnf` support all the formatting verbs of the [fmt](https://golang.org/pkg/fmt/) package. + +## Suppress errors + +Some times it may make sense to let the user suppress an ERROR and make the build succeed. + +You can do this by using the `erroridf` function. This functions takes an error ID as the first arument. + + +`` +{{ erroridf "my-custom-error" "You should consider fixing this."}} +``` + +This will produce: + +``` +ERROR 2021/06/07 17:47:38 You should consider fixing this. +If you feel that this should not be logged as an ERROR, you can ignore it by adding this to your site config: +ignoreErrors = ["my-custom-error"] +```