Allow github trigger to match on branches/refs
Change-Id: If33d5566813f08704db2ed6983541eec31c96a55
diff --git a/doc/source/triggers.rst b/doc/source/triggers.rst
index d8c7ee8..07b18ab 100644
--- a/doc/source/triggers.rst
+++ b/doc/source/triggers.rst
@@ -128,6 +128,11 @@
*push* - head reference updated (pushed to branch)
+ **branch**
+ The branch associated with the event. Example: ``master``. This
+ field is treated as a regular expression, and multiple branches may
+ be listed. Used for ``pull-request`` events.
+
**comment**
This is only used for ``pull_request`` ``comment`` events. It accepts a list
of regexes that are searched for in the comment string. If any of these
@@ -143,8 +148,10 @@
``unlabeled`` action when a label with name ``do not test`` is removed from
the pull request.
- Additionally a ``push`` event can be configured, with an
- associated ``ref`` represented as a regex to match branches or tags.
+ Additionally a ``push`` event can be configured, with an ``ref`` field. This
+ field is treated as a regular expression and multiple refs may be listed.
+ Github always sends full ref name, eg. ``refs/tags/bar`` and this string is
+ matched against the regexp.
GitHub Configuration
~~~~~~~~~~~~~~~~~~~~