diff mbox

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

Message ID 0c479a0c-791c-2c1c-8fa7-ca7c1e904bdb@suse.cz
State New
Headers show

Commit Message

Martin Liška Aug. 16, 2016, 11:55 a.m. UTC 
On 08/15/2016 05:40 PM, Gerald Pfeifer wrote:
> Hi Martin,
> 
> On Mon, 15 Aug 2016, Martin Liška wrote:
>> Ready to be installed?
> 
> you ignored (or I guess: missed) the updated patch that I
> included in my previous message.  Can you use that instead
> of your original?

Ah, sorry for not adopting your changes, fixed in the next
version of patch.

> 
> As for the examples, I would omit the output of the script,
> since otherwise we'll need to adjust that whenever the output
> changes, and it's a bit lengthy. ;-)  And potentially use a 
> few words to describe the scenario instead for those cases
> where there is no --comment options?

Sure, I've replaced output with command invocation explanation.
I'm leaving for vacation tomorrow, thus I'll commit a final
version tomorrow in the afternoon.

Martin

> 
> 
> Clearly this is an improvement, so let's give Richi a day to
> chime in and then go ahead with whatever you have.
> 
> Gerald
>
diff mbox

Patch

From c9057aa77ad7c1dc754ead66f970b969b3c73543 Mon Sep 17 00:00:00 2001
From: marxin <mliska@suse.cz>
Date: Fri, 12 Aug 2016 15:27:29 +0200
Subject: [PATCH] Document branch_changer.py script

maintainer-scripts/ChangeLog:

2016-08-12  Martin Liska  <mliska@suse.cz>

	* branch_changer.py: Describe the script. Add sample usage
	of the script.
---
 maintainer-scripts/branch_changer.py | 38 ++++++++++++++++++++++++++++++++----
 1 file changed, 34 insertions(+), 4 deletions(-)

diff --git a/maintainer-scripts/branch_changer.py b/maintainer-scripts/branch_changer.py
index 5e1681b..b058029 100755
--- a/maintainer-scripts/branch_changer.py
+++ b/maintainer-scripts/branch_changer.py
@@ -1,9 +1,39 @@ 
 #!/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
+#
+# Sample usages of the script:
+#
+# $ ./maintainer-scripts/branch_changer.py api_key --new-target-milestone=6.2:6.3 --comment '6.2 has been released....' --add-known-to-fail=6.2 --limit 3
+#
+# The invocation will set target milestone to 6.3 for all issues that
+# have mistone equal to 6.2. Apart from that, a comment is added to these
+# issues and 6.2 version is added to known-to-fail versions.
+# At maximum 3 issues will be modified and the script will run
+# in dry mode (no issues are modified), unless you append --doit option.
+#
+# $ ./maintainer-scripts/branch_changer.py api_key --new-target-milestone=5.5:6.3 --comment 'GCC 5 branch is being closed' --remove 5 --limit 3
+#
+# Very similar to previous invocation, but instead of adding to known-to-fail,
+# '5' release is removed from all issues that have the regression prefix.
+#
+# $ ./maintainer-scripts/branch_changer.py api_key --add=7:8
+#
+# Aforementioned invocation adds '8' release to the regression prefix of all
+# issues that contain '7' in its regression prefix.
+#
 
 import requests
 import json
-- 
2.9.2