diff options
| author | Felix Edel <felix.fs.schmidt@bmw.de> | 2020-01-23 09:38:37 +0100 |
|---|---|---|
| committer | Felix Edel <felix.edel@bmw.de> | 2020-02-19 13:31:49 +0100 |
| commit | 33f87bea9c5f7d07b247437155a1282ce0981e5b (patch) | |
| tree | 72d3e4fdb4e9be150b3a982583a08874cfe665dd /releasenotes/notes/github-checks-api-a990a473c37b4db4.yaml | |
| parent | 1914417dd4de38fb7b19e194cd666ce0b96a86d6 (diff) | |
| download | zuul-33f87bea9c5f7d07b247437155a1282ce0981e5b.tar.gz | |
Implement basic github checks API workflow
Utilizing the checks API to report the build state to Github provides
some additional functionality that is not supported by the status API.
Those are:
- Defining custom actions to e.g. cancel a running build
- Report line-based file annotations
This change implements the basic checks API workflow. Once this is in
place, the additional features could simply be added on top.
Change-Id: I7e790783ee35971085863b5487ff094fa0b23d65
Story: 2007268
Task: 38672
Diffstat (limited to 'releasenotes/notes/github-checks-api-a990a473c37b4db4.yaml')
| -rw-r--r-- | releasenotes/notes/github-checks-api-a990a473c37b4db4.yaml | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/releasenotes/notes/github-checks-api-a990a473c37b4db4.yaml b/releasenotes/notes/github-checks-api-a990a473c37b4db4.yaml new file mode 100644 index 000000000..de7c68616 --- /dev/null +++ b/releasenotes/notes/github-checks-api-a990a473c37b4db4.yaml @@ -0,0 +1,12 @@ +--- +features: + - | + The Github driver now has a basic support for the Github checks API. + To enable reporting build results via the checks API one can configure the + the new :attr:`pipeline.<reporter>.<github source>.check` attribute on the + Github reporter. It's also possible to trigger on a requested or completed + :value:`pipeline.trigger.<github source>.event.check_run`. + + To be able to use the checks API, zuul must be authenticated as Github + app. For more information about the necessary requirements, please see + the :ref:`github_driver` driver documentation. |