Skip to content

packagekit: link Red Hat issue references in changelogs#23117

Open
tarunvashishth wants to merge 2 commits intocockpit-project:mainfrom
tarunvashishth:packagekit-changelog-issue-links
Open

packagekit: link Red Hat issue references in changelogs#23117
tarunvashishth wants to merge 2 commits intocockpit-project:mainfrom
tarunvashishth:packagekit-changelog-issue-links

Conversation

@tarunvashishth
Copy link
Copy Markdown

closes #17748

  • Linkify rhbz# and jira# references in update changelogs.
  • Apply linkification only on Red Hat-family distros (RHEL/Fedora/CentOS).
  • Add a mock update entry to make manual verification easy.

Copy link
Copy Markdown
Member

@Venefilyn Venefilyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! In short I like it but atm I'm skeptical about how the Jira linking is supposed to work. The RHBZ can be made non-distro specific too

Comment on lines +146 to +149
if (!text || !isRedHatBasedDistribution())
return text;

const issuePattern = /(rhbz|jira)#(\d+)/g;
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can check for rhbz no matter the distro tbh. I don't think anyone else refers to their trackers as rhbz and it is quite normal to link to in regards to CVEs etc.

However, with Jira I agree that we should only link to it within RHEL-sphere, but is it common to write jira#1234? That feels very strange to me as it doesn't include the namespace at all like RHEL-1234.

Do you have links to where the jira#1234 syntax is used?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn’t find solid evidence that jira#1234 is being used; most Red Hat references I found are RHEL-1234. Should I drop the Jira part and add something like RHEL-1234?

At some point we change to an object with keys to a list with all the
objects in it and looking at ID instead. To make it work during manual
testing we need to update the syntax from object to array.

Signed-off-by: Freya Gustavsson <freya@venefilyn.se>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clickable BZ links in update changelog

2 participants