diff mbox

[COMMITTED] Add branch_changer.py script to maintainer-scripts

Message ID alpine.LSU.2.20.1608141832170.2571@anthias.pfeifer.com
State New
Headers show

Commit Message

Gerald Pfeifer Aug. 14, 2016, 4:35 p.m. UTC 
Hi Martin,

On Fri, 12 Aug 2016, Martin Liška wrote:
>> I think it would be good to add a comment at the top that
>> describes what the scripts does and how to invoke the script?
> Sure, what about this?

your patch definitely is a nice improvement.  Instead of providing
editorial comments, allow me provide an updated patch (below).

The one thing that would be really good to add is documentation on
the usage of the script and/or examples for relevant invocations.

Thanks,
Gerald
diff mbox

Patch

Index: branch_changer.py
===================================================================
--- branch_changer.py	(revision 239456)
+++ branch_changer.py	(working copy)
@@ -1,10 +1,19 @@ 
 #!/usr/bin/env python3
 
-# The script requires simplejson, requests, semantic_version packages, in case
-# of openSUSE:
-# zypper in python3-simplejson python3-requests
-# pip3 install semantic_version
+# This script is used by maintainers to modify Bugzilla entries in batch
+# mode.
+# Currently it can remove and add a release from/to PRs that are prefixed
+# with '[x Regression]'. Apart from that, it can also change target
+# milestones and optionally enhance the list of known-to-fail versions.
+#
+# The script utilizes the Bugzilla API, as documented here:
+# http://bugzilla.readthedocs.io/en/latest/api/index.html
 
+# It requires the simplejson, requests, semantic_version packages.
+# In case of openSUSE:
+#   zypper in python3-simplejson python3-requests
+#   pip3 install semantic_version
+
 import requests
 import json
 import argparse