Generalize Gerrit non-voting Review Macro Name 99/35899/2
authorTrevor Bramwell <tbramwell@linuxfoundation.org>
Wed, 7 Jun 2017 21:55:09 +0000 (14:55 -0700)
committerTrevor Bramwell <tbramwell@linuxfoundation.org>
Mon, 19 Jun 2017 23:42:18 +0000 (16:42 -0700)
This patch updates the 'report-docs-build-result-to-gerrit' macro name
to reflect that it can work well for more than just the opnfvdocs project.

To take advantage of this macro a build merely needs to write
out the file 'gerrit_comment.txt' with the information they want posted
back to gerrit, and include the macro in the list of builders.

Change-Id: Ifbdc5734fe7e7231be0cfd16d6b8d69cb1383bfd
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
jjb/global/releng-macros.yml

index ced335c..338b8aa 100644 (file)
             find "$local_path" | grep -e 'index.html$' -e 'pdf$' | \
                 sed -e "s|^$local_path|    http://$gs_path|" >> gerrit_comment.txt
 
+# To take advantage of this macro, have your build write
+# out the file 'gerrit_comment.txt' with information to post
+# back to gerrit and include this macro in the list of builders.
 - builder:
-    name: report-docs-build-result-to-gerrit
+    name: report-build-result-to-gerrit
     builders:
         - shell: |
             #!/bin/bash
     builders:
         - build-html-and-pdf-docs-output
         - upload-under-review-docs-to-opnfv-artifacts
-        - report-docs-build-result-to-gerrit
+        - report-build-result-to-gerrit
 
 - builder:
     name: upload-merged-docs
     builders:
         - build-html-and-pdf-docs-output
         - upload-generated-docs-to-opnfv-artifacts
-        - report-docs-build-result-to-gerrit
+        - report-build-result-to-gerrit
         - remove-old-docs-from-opnfv-artifacts
 
 - builder: