lix-project/hydra
3
0
Fork 6
Code Issues 2 Pull requests Packages Projects Releases Wiki Activity

docs: improve github status plugin documentation

Browse source
This commit is contained in:
Jörg Thalheim 2021-10-30 09:37:42 +02:00
parent 9ae676072c
commit cdddbb89f3
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/manual/src/plugins/README.md
View file

@ -111,7 +111,7 @@ Sets GitHub CI status.
- `githubstatus.[].jobs` - `githubstatus.[].jobs`
Regular expression for jobs to match in the format `project:jobset:job`. 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` - `githubstatus.[].excludeBuildFromContext`
@ -140,15 +140,18 @@ status we want to report. Can be repeated.
Verbatim contents of the Authorization header. See Verbatim contents of the Authorization header. See
[GitHub documentation](https://developer.github.com/v3/#authentication) for [GitHub documentation](https://developer.github.com/v3/#authentication) for
details. details. This field is only used if `github_authorization.<repo-owner>` is not set.
### Example ### Example
```xml ```xml
<githubstatus> <githubstatus>
jobs = test:pr:build jobs = test:pr:build
## This example will match all jobs
#jobs = .*
inputs = src inputs = src
authorization = Basic notgivingyoumypasswordosorry authorization = Bearer gha-secret😱secret😱secret😱
excludeBuildFromContext = 1 excludeBuildFromContext = 1
</githubstatus> </githubstatus>
``` ```