Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add support for highlighting CVEs refercned in changelog entries #18

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

philroche
Copy link
Contributor

@philroche philroche commented Nov 5, 2022

Some changelog entries can be very long and hard to manually parse, especially when looking for references to CVEs in kernel changelogs.

This commits adds three new arguments. All three are flags.

--highlight-cves:
Highlight the CVEs referenced in each individual changelog entry
--highlight-cves-only:
Highlight the CVEs referenced in each individual changelog entry
but do NOT show the rest of the content of the changelog entry
--highlight-cves-show-cve-description:
When highlighting CVEs, show the CVE description

--highlight-cves or --highlight-cve-only must also be used for this to take affect.

Examples added to Readme too.

@philroche philroche changed the title feat: Add support for highlighting CVEs addressed/mitigated in change… feat: Add support for highlighting CVEs refercned in changelog entries Nov 5, 2022
@philroche philroche force-pushed the feature/highlight-cves branch 7 times, most recently from a3ec468 to 1025d3f Compare November 5, 2022 15:14
Some changelog entries can be very long and hard to manually parse, especially when looking for references to CVEs in kernel changelogs.

This commits adds three new arguments. All three are flags.

`--highlight-cves`:
  Highlight the CVEs referenced in each individual changelog entry
`--highlight-cves-only`:
  Highlight the CVEs referenced in each individual changelog entry
  but do NOT show the rest of the content of the changelog entry
`--highlight-cves-show-cve-description`:
  When highlighting CVEs, show the CVE description

  `--highlight-cves` or `--highlight-cve-only`  must also be used for this to take affect.

Examples added to Readme too.
@philroche philroche force-pushed the feature/highlight-cves branch from 1025d3f to 9735c28 Compare November 5, 2022 15:22

# this is the first line of a changelog entry. Find the version and reset lists for
# changelog entry lines and changelog entry cves
if source_package_name in line and line.startswith(source_package_name) and ' (' in line and ')' in line:
Copy link
Owner

Choose a reason for hiding this comment

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

can we use the python-debian module to do that? then we would get a list of changes from that module. eg:

c = debian.changelog.Changelog(open('/home/tom/tmp/changelog'))

I also wonder if we should add a method to that module to get a list of CVEs (similar to the method which provides a list of closed LP bugs:

>>> c[0].lp_bugs_closed
[1989194, 1993204]

…o highlight

If not, state that there are no CVEs addressed/mitigated for this version.
@philroche philroche force-pushed the feature/highlight-cves branch from 4d84c71 to 8dd48c2 Compare December 1, 2022 13:53
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.

2 participants