From cdddbb89f38971b9ace87b1a08eddcf5932c338a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Sat, 30 Oct 2021 09:37:42 +0200 Subject: [PATCH] docs: improve github status plugin documentation --- doc/manual/src/plugins/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/manual/src/plugins/README.md b/doc/manual/src/plugins/README.md index 25ea6e3a..4212f429 100644 --- a/doc/manual/src/plugins/README.md +++ b/doc/manual/src/plugins/README.md @@ -111,7 +111,7 @@ Sets GitHub CI status. - `githubstatus.[].jobs` Regular expression for jobs to match in the format `project:jobset:job`. -Defaults to `*:*:*`. +This field is required and has no default value. - `githubstatus.[].excludeBuildFromContext` @@ -140,15 +140,18 @@ status we want to report. Can be repeated. Verbatim contents of the Authorization header. See [GitHub documentation](https://developer.github.com/v3/#authentication) for -details. +details. This field is only used if `github_authorization.` is not set. + ### Example ```xml jobs = test:pr:build + ## This example will match all jobs + #jobs = .* inputs = src - authorization = Basic notgivingyoumypasswordosorry + authorization = Bearer gha-secret😱secret😱secret😱 excludeBuildFromContext = 1 ```