summaryrefslogtreecommitdiff
path: root/releasenotes
diff options
context:
space:
mode:
authorFelix Edel <felix.edel@bmw.de>2020-02-14 14:05:44 +0100
committerFelix Edel <felix.edel@bmw.de>2020-02-19 14:01:41 +0100
commitfe3b5e3bae70b0591a19cc8992484790411d2a2b (patch)
treee220668f3a87e133c71af23d22ce7c3251aec677 /releasenotes
parent33f87bea9c5f7d07b247437155a1282ce0981e5b (diff)
downloadzuul-fe3b5e3bae70b0591a19cc8992484790411d2a2b.tar.gz
Support file comments via Github checks API
Zuul is already providing these file comments via the zuul_return value. So far, the Github reporter wasn't able to use those, but with the help of the checks API we can add so called "annotations" to each check run. Change-Id: Iff10172f95dc0430bec8e4dafb9a6c09bbe06077
Diffstat (limited to 'releasenotes')
-rw-r--r--releasenotes/notes/github-checks-annotations-0b3e417b167e58d2.yaml10
1 files changed, 10 insertions, 0 deletions
diff --git a/releasenotes/notes/github-checks-annotations-0b3e417b167e58d2.yaml b/releasenotes/notes/github-checks-annotations-0b3e417b167e58d2.yaml
new file mode 100644
index 000000000..2e744fb27
--- /dev/null
+++ b/releasenotes/notes/github-checks-annotations-0b3e417b167e58d2.yaml
@@ -0,0 +1,10 @@
+---
+features:
+ - |
+ The Github driver can now report file comments via Github checks API.
+ If a github reporter is configured to use the checks API, file comments
+ provided via ``zuul_return`` will automatically be reported to the pull
+ request in Github.
+
+ For more details on how to provide file comments from Zuul, see the
+ documentation of the :ref:`return_values`.