Skip to content

Add JS clickable tab link functionality#1288

Merged
TG1999 merged 4 commits into
mainfrom
1286-add-clickable-links-to-tabs
Aug 31, 2023
Merged

Add JS clickable tab link functionality#1288
TG1999 merged 4 commits into
mainfrom
1286-add-clickable-links-to-tabs

Conversation

@johnmhoran

Copy link
Copy Markdown
Member

Reference: #1286

Reference:

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@johnmhoran
johnmhoran requested a review from TG1999 August 31, 2023 02:17
@johnmhoran

Copy link
Copy Markdown
Member Author

@TG1999 I just finished adding two simple JavaScript-based clickable tab links to the Vulnerability details template. Please give this a close look and let me know if you have any comments, suggestions etc.

I opened this PR and all tests passed, but 2 documentation builds threw a warning, treated as an error, and thus those 2 builds failed. The warnings are identical and have nothing to do with my work -- related to a broken links in importers_link.rst.

Warning, treated as error:
/home/runner/work/vulnerablecode/vulnerablecode/docs/source/importers_link.rst:22:broken link: https://www.debian.org/security/oval/ (403 Client Error: Forbidden for url: https://www.debian.org/security/oval/)
(  importers_link: line   22) 
Error: Process completed with exit code 2.

@johnmhoran

Copy link
Copy Markdown
Member Author

@TG1999 The errors in the documentation build refer to importers_link.rst, which contains an include for SOURCES.rst, which itself contains a table of importer links (see https://github.com/nexB/vulnerablecode/blob/main/SOURCES.rst), one of which is the link for debian oval -- https://www.debian.org/security/oval/. This currently takes me to

image

This is similar to the link in /vulnerablecode/vulnerabilities/importers/debian_oval.py -- file_url = f"https://www.debian.org/security/oval/oval-definitions-{release}.xml", which also leads to the same sort of Forbidden page.

Many of the first group of hits in a Google search for debian oval security also lead to a Forbidden page.

It would be interesting to know when the debian_oval importer was last run and whether it encountered the same Forbidden page and threw an error. I assume that if it were to be run right now, it would fail/throw some sort of error. Do we know when it was last run?

In any event, that URL seems at least temporarily invalid. My suggestion for this PR is to disregard those documentation builds for now and, subject to any corrections of this tab-link work, that the PR be merged into main.

@TG1999 TG1999 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@johnmhoran some nits for your consideration

Comment thread vulnerabilities/templates/vulnerability_details.html Outdated
Comment thread vulnerabilities/templates/vulnerability_details.html Outdated
Reference: #1286

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Reference: #1286

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@TG1999

TG1999 commented Aug 31, 2023

Copy link
Copy Markdown
Contributor

@johnmhoran please add CHANGELOG for this and #1279

@johnmhoran

Copy link
Copy Markdown
Member Author

@TG1999 In my current local CHANGELOG.rst, the most recent heading is Version v33.4.0. Should I add a bullet under that heading for issues #1286 and #1279? Or a new heading?

@TG1999

TG1999 commented Aug 31, 2023

Copy link
Copy Markdown
Contributor

@johnmhoran please add a new heading Next Release and put these bullet points under that

@johnmhoran

Copy link
Copy Markdown
Member Author

Thanks @TG1999 -- will do.

Reference: #1279

Reference: #1286

- Updated CHANGELOG.rst for issues 1279 and 1286.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@johnmhoran

Copy link
Copy Markdown
Member Author

@TG1999 CHANGELOG.rst updated a little while ago.

@TG1999 TG1999 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! Thanks++

@TG1999
TG1999 merged commit eec05bb into main Aug 31, 2023
@johnmhoran
johnmhoran deleted the 1286-add-clickable-links-to-tabs branch August 31, 2023 16:56
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