From 2b2f687fb0211dec3673600bf6e722155c24b09f Mon Sep 17 00:00:00 2001
From: Martin Liska <mliska@suse.cz>
Date: Fri, 9 Apr 2021 13:18:24 +0200
Subject: [PATCH] branch_changer.py: document more behavior.
maintainer-scripts/ChangeLog:
* branch_changer.py: Document more how the script behaves.
---
maintainer-scripts/branch_changer.py | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/maintainer-scripts/branch_changer.py b/maintainer-scripts/branch_changer.py
index de252d26ac4e..0f0cbaf43e06 100755
--- a/maintainer-scripts/branch_changer.py
+++ b/maintainer-scripts/branch_changer.py
@@ -30,6 +30,13 @@
#
# 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.
+# NOTE: If the version 5 is the only one in regression marker ([5 Regression] ...),
+# then the bug summary is not modified.
+#
+# NOTE: If we change target milestone in between releases and the PR does not
+# regress in the new branch, then target milestone change is skipped:
+#
+# not changing target milestone: not a regression or does not regress with the new milestone
#
# $ ./maintainer-scripts/branch_changer.py api_key --add=7:8
#
@@ -102,7 +109,7 @@ class Bug:
new_summary = self.serialize_summary()
if new_summary != summary:
print(self.name())
- print(' changing summary: "%s" to "%s"' % (summary, new_summary))
+ print(' changing summary to "%s"' % (new_summary))
self.modify_bug(api_key, {'summary': new_summary}, doit)
return True
--
GitLab