RHEL-9: Migrate `makebumpver` script from Bugzilla to JIRA #5349

jkonecny12 · 2023-11-28T11:32:04Z

Migrate our current makebumpver script from Bugzilla checking to JIRA.

We are changing the convention from:

Resolves: rhbz#<bug number>
Related: rhbz#<bug number>

to

Resolves: <RHEL issue>
Related: <RHEL issue>

This script is a bit outdated so let's take a brief change on this during the path:

Base migration to pep8 (still names of the variables and functions are not correct)
Backport fix to work with infra: ... together with ... (#infra) in the infra commits - improves backporting for us
Improve duplication in the code
Improve logging - less mess up output compared until you enable --debugging
Switch from sys.std*** to print

jkonecny12 · 2023-11-28T12:28:24Z

Blocked by #5348 and #5351

jstodola · 2023-11-28T14:16:11Z

scripts/makebumpver

@@ -1,3 +1,10 @@
+# ======================================
+# WARNING!
+# THIS FILE IS GENERATED FROM A TEMPLATE


I wonder why is this file needed to be in git, since it can be generated anytime from the template.

It is one to be used. Our templating system works like:

The template file .j2 is the only file you should ever modify

The output file (this one) is what you should use

Both are committed because otherwise you would have to generate the file every time you need to use it. Which makes especially automation harder.

Automation could generate makebumpver automatically from the .j2 template before use. My worry is that any modification has to be done in both files and committed to git to keep the files in sync. With just the template you do not have such a problem. But if keeping the files in sync is no big deal and modifications are rare, why not.

jstodola · 2023-11-28T14:34:00Z

scripts/makebumpver.j2

+    def validate_RHEL_issue_status(self, bug):
+        issue = self._query_RHEL_issue(bug)
+
+        valid_statuses = ("Planning", "In Progress", "Integration")


IMO, you should not make modifications to bugs in the "Integration" state - such a bug is in hands of QE and no changes should be made there any more. The correct way is to move the bug back to "In Progress" and then make the necessary changes.

I wasn't sure about this one. Thanks for the reply!

jstodola · 2023-11-28T14:44:12Z

scripts/makebumpver.j2

+            m = re.match(branch_pattern, self.git_branch)
+            if m:
+                return m.group(1)
+            rhel8_branch_pattern = r"^rhel-(\d+)(.*)"


I find rhel8_branch_pattern confusing, branch names for both RHEL-8 and RHEL-9 look the same (rhel-8, rhel-9)

Again, maybe a separate PR, but I would be also fine with this PR.

Seems like a leftover from the original parts of the script :D

I'll add a new commit fixing this on the pile.

jstodola · 2023-11-28T14:53:24Z

scripts/makebumpver.j2

+        summary = summary + f" ({author})"
+
+        for bodyline in body:
+            m = re.match(r"^(Resolves|Related):\ +jira#\w+-\d+.*$", bodyline)


Why not allow also "Resolves:jira#RHEL-11111" (without the space)?

We never had that as the convention and I don't think we want to start with that now.

jstodola · 2023-11-28T14:59:06Z

scripts/makebumpver.j2

+                # store the bug to output list if checking is disabled and continue
+                if self.skip:
+                    issues.add(f"{action}: jira#{bug}")
+                    print(f"*** Bug {bug} Related commit {commit} is allowed\n")


It's not checked if the commit is allowed, so the log message should be updated accordingly.

This message is similar to what was the original message, however, I agree it could be improved now. Will do.

jstodola · 2023-11-28T15:10:59Z

scripts/makebumpver.j2

+            return False
+
+        if self.git_branch.startswith('rhel'):
+            branch_pattern = r"^rhel(\d+)-(.*)"


Is this branch pattern still used?

I think it is not. Maybe I'd remove it in a follow-up separate PR, but I'd be fine with a commit in this set as well.

Not really important. The script will not be moved to RHEL-10 it will go there from master. Let's fix this on master separately.

rvykydal · 2023-11-29T09:24:17Z

scripts/makebumpver.j2

+
+        rpm_log = []
+        bad_bump = False
+        bad = False


Maybe we can get rid of one of the bad and bad_bump variables now.

Good point.

jkonecny12 · 2023-12-01T13:59:15Z

I see what is happening. By creating a j2 template file all the lines changed not just the lines I touched, so I'm getting review also for parts which doesn't changed by me and they are just copied over. I guess that is fine.

@jstodola the easiest way to do the review (based on my experience) is to do that by commit and if it is move the code to j2 file. You can just take a look on the generated file which will show you the changes and completely skip reading of the j2 file.

(cherry picked from commit 1769a7d)

(cherry picked from commit 5102cae)

Let's make this consistent through the file.

Let's make the method a bit more sane by moving the bug checking code out of giant if clause.

Let's make it a function instead of copied code on plenty of places.

Without this change we will get all the debug outputs from the bugzilla JIRA calls which makes the output hard to read. Let's enable these only in debugging mode.

jkonecny12 · 2023-12-01T14:35:07Z

Updated and prepared for review and hopefully merge :).

jkonecny12 · 2023-12-01T14:35:48Z

/kickstart-test --waive infra only

scripts/makebumpver

jstodola · 2023-12-01T15:19:41Z

scripts/makebumpver.j2

+                # store the bug to output list if checking is disabled and continue
+                if self.skip:
+                    issues.add(f"{action}: jira#{bug}")
+                    print(f"*** Bug {bug} Related commit {commit} is skipped\n")


Is the commit really skipped? Just the checks are skipped, aren't they?

I see, yeah, it might be more clear with skipping checks probably.

jkonecny12 · 2023-12-01T15:57:06Z

Fixed notes from the last review.

jstodola

It looks OK.

jkonecny12 · 2023-12-04T13:52:47Z

UPDATED: Moved the templating out of main script.

VladimirSlavik

LGTM. Thank you for not changing the whole file into a template :)

There are some nitpicks, but feel free to ignore these.

scripts/makebumpver

Validate JIRA issues on commits with Red Hat JIRA and not to bugzilla anymore. From RHEL-8.10 and RHEL-9.4 Bugzilla is not used by Red Hat any JIRA is the successor. Let's adapt this script to that. It's simplified version of RHBZ solution. What is different: * JIRA don't have ACKs but instead states * JIRA don't support Related / Resolves - still in the code because it could help us but JIRA is just taking the issue and ignores the rest. * Don't support BZ in summary (we are not using that anymore) * Print confirmation that the given commit is correct

Remove Bugzilla code which was migrated to JIRA and remove arguments which can't be reasonably used with JIRA. Remove: --map Mapping between Fedora and RHEL bugs is functionality which is not used anymore and it can't be even reasonably used from Bugzilla to JIRA. --skip-acks and --skip-all was renamed to --skip ACKs are not used on JIRA anymore so having two different skip parameters doesn't help. unused variable bad_bump

Let's make the script working between branching by getting the version validation from the templates.

We don't use Bugzilla anymore for RHEL bugs. Bugzilla was migrated to JIRA.

Fix the variable naming. We are not on RHEL-8 anymore :).

If user is missing python3-jira library let's tell them where to get it.

jkonecny12 · 2023-12-05T11:59:15Z

Applied improvement from note from @VladimirSlavik and also found a bug in the code in error reporting - fixed now.

jkonecny12 · 2023-12-05T14:43:18Z

/kickstart-test --waive infra only

jkonecny12 added the rhel-9 label Nov 28, 2023

jkonecny12 requested a review from jstodola November 28, 2023 11:32

jkonecny12 changed the title ~~RHEL-9: Migrate makebumpver script from Bugzilla to JIRA~~ RHEL-9: Migrate makebumpver script from Bugzilla to JIRA Nov 28, 2023

This was referenced Nov 28, 2023

RHEL-9: Migrate makebumpver script from Bugzilla to JIRA (replaced by #5349) #5347

Closed

infra: Ignore j2 files by pylint #5351

Merged

jkonecny12 added port to Fedora port to RHEL8 blocked Don't merge this pull request! infrastructure Changes affecting mostly infrastructure labels Nov 28, 2023

jstodola reviewed Nov 28, 2023

View reviewed changes

rvykydal reviewed Nov 29, 2023

View reviewed changes

VladimirSlavik and others added 7 commits December 1, 2023 15:28

infra: bumpver: Ignore dependabot commits in changelog

f3d5136

(cherry picked from commit 1769a7d)

infra: bumpver: Ignore all infra, not just bumps

68bf509

(cherry picked from commit 5102cae)

infra: bumpver: Switch sys.std***.write to print

3eef8d6

Let's make this consistent through the file.

infra: bumpver: Move out rhel bug checking

7d0bbe2

Let's make the method a bit more sane by moving the bug checking code out of giant if clause.

infra: bumpver: Migrate to pep8

0c7b25e

infra: bumpver: Move failure prints to a function

a5533d4

Let's make it a function instead of copied code on plenty of places.

infra: bumpver: Removing unnecassary logging

03e9e50

Without this change we will get all the debug outputs from the bugzilla JIRA calls which makes the output hard to read. Let's enable these only in debugging mode.

jkonecny12 force-pushed the rhel-9-switch-makebumpver-to-jira branch from 0490a0d to 52bebed Compare December 1, 2023 14:31

jkonecny12 removed the blocked Don't merge this pull request! label Dec 1, 2023

VladimirSlavik reviewed Dec 1, 2023

View reviewed changes

scripts/makebumpver Outdated Show resolved Hide resolved

scripts/makebumpver Outdated Show resolved Hide resolved

jstodola reviewed Dec 1, 2023

View reviewed changes

jkonecny12 force-pushed the rhel-9-switch-makebumpver-to-jira branch 2 times, most recently from 7f937c1 to d2b3a3f Compare December 1, 2023 15:56

jstodola approved these changes Dec 1, 2023

View reviewed changes

jkonecny12 force-pushed the rhel-9-switch-makebumpver-to-jira branch from d2b3a3f to 2d6b007 Compare December 4, 2023 13:51

VladimirSlavik approved these changes Dec 5, 2023

View reviewed changes

scripts/makebumpver Outdated Show resolved Hide resolved

scripts/makebumpver Outdated Show resolved Hide resolved

jkonecny12 added 6 commits December 5, 2023 12:56

infra: bumpver: Use templating for the script

702cfe0

Let's make the script working between branching by getting the version validation from the templates.

Update documentation for RHEL contributions

40b80e4

We don't use Bugzilla anymore for RHEL bugs. Bugzilla was migrated to JIRA.

infra: bumpver: Fix variable naming

dc70b51

Fix the variable naming. We are not on RHEL-8 anymore :).

infra: bumpver: Guide user on missing library

bb68822

If user is missing python3-jira library let's tell them where to get it.

jkonecny12 force-pushed the rhel-9-switch-makebumpver-to-jira branch from 2d6b007 to bb68822 Compare December 5, 2023 11:58

VladimirSlavik approved these changes Dec 6, 2023

View reviewed changes

jkonecny12 merged commit 194e96c into rhinstaller:rhel-9 Dec 6, 2023
5 of 6 checks passed

jkonecny12 mentioned this pull request Dec 7, 2023

RHEL-8: Migrate makebumpver script from Bugzilla to JIRA #5367

Merged

jkonecny12 removed the port to RHEL8 label Dec 14, 2023

jkonecny12 mentioned this pull request Dec 14, 2023

Switch makebumpver to jira #5380

Merged

jkonecny12 removed the port to Fedora label Dec 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RHEL-9: Migrate `makebumpver` script from Bugzilla to JIRA #5349

RHEL-9: Migrate `makebumpver` script from Bugzilla to JIRA #5349

jkonecny12 commented Nov 28, 2023 •

edited

Loading

jkonecny12 commented Nov 28, 2023

jstodola Nov 28, 2023

jkonecny12 Dec 1, 2023

jstodola Dec 1, 2023

jstodola Nov 28, 2023

jkonecny12 Dec 1, 2023

jstodola Nov 28, 2023

rvykydal Nov 29, 2023

jkonecny12 Dec 1, 2023

jkonecny12 Dec 1, 2023

jstodola Nov 28, 2023

jkonecny12 Dec 1, 2023

jstodola Nov 28, 2023

jkonecny12 Dec 1, 2023

jstodola Nov 28, 2023

rvykydal Nov 29, 2023

jkonecny12 Dec 1, 2023

rvykydal Nov 29, 2023

jkonecny12 Dec 1, 2023

jkonecny12 commented Dec 1, 2023

jkonecny12 commented Dec 1, 2023

jkonecny12 commented Dec 1, 2023

jstodola Dec 1, 2023

jkonecny12 Dec 1, 2023

jkonecny12 commented Dec 1, 2023

jstodola left a comment

jkonecny12 commented Dec 4, 2023

VladimirSlavik left a comment

jkonecny12 commented Dec 5, 2023

jkonecny12 commented Dec 5, 2023

RHEL-9: Migrate makebumpver script from Bugzilla to JIRA #5349

RHEL-9: Migrate makebumpver script from Bugzilla to JIRA #5349

Conversation

jkonecny12 commented Nov 28, 2023 • edited Loading

jkonecny12 commented Nov 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkonecny12 commented Dec 1, 2023

jkonecny12 commented Dec 1, 2023

jkonecny12 commented Dec 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkonecny12 commented Dec 1, 2023

jstodola left a comment

Choose a reason for hiding this comment

jkonecny12 commented Dec 4, 2023

VladimirSlavik left a comment

Choose a reason for hiding this comment

jkonecny12 commented Dec 5, 2023

jkonecny12 commented Dec 5, 2023

RHEL-9: Migrate `makebumpver` script from Bugzilla to JIRA #5349

RHEL-9: Migrate `makebumpver` script from Bugzilla to JIRA #5349

jkonecny12 commented Nov 28, 2023 •

edited

Loading