Skip to content

Link sanity #1048

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.

Sign up for GitHub

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

Merged
Hritik14 merged 2 commits into from
Dec 27, 2022
Merged

Link sanity #1048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
816ad5e
Enable linkcheck and nitpicky
Hritik14 Dec 26, 2022
ec9d38d
Enable linkcheck in GH actions
Hritik14 Dec 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ jobs:

- name: Check Sphinx Documentation build minimally
working-directory: ./docs
run: sphinx-build -E source build
run: sphinx-build -b linkcheck -EW source build

- name: Check for documentation style errors
working-directory: ./docs
run: ./scripts/doc8_style_check.sh
run: ./scripts/doc8_style_check.sh
30 changes: 15 additions & 15 deletions SOURCES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,41 @@
+================+======================================================================================================+====================================================+
|rust | https://github.com/RustSec/advisory-db |rust crates |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|alpine | https://secdb.alpinelinux.org/ |alpine packages |
|alpine | https://secdb.alpinelinux.org/ |alpine packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|archlinux | https://security.archlinux.org/json |arch packages |
|archlinux | https://security.archlinux.org/json |arch packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|debian | https://security-tracker.debian.org/tracker/data/json |debian packages |
|debian | https://security-tracker.debian.org/tracker/data/json |debian packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|npm | https://github.com/nodejs/security-wg.git |npm packages |
|npm | https://github.com/nodejs/security-wg.git |npm packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|ruby | https://github.com/rubysec/ruby-advisory-db.git |ruby gems |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|ubuntu | https://people.canonical.com/~ubuntu-security/oval/ |ubuntu packages |
|ubuntu | https://people.canonical.com/~ubuntu-security/oval/ |ubuntu packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|retiredotnet | https://github.com/RetireNet/Packages.git |.NET packages |
|retiredotnet | https://github.com/RetireNet/Packages.git |.NET packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|suse_backports | http://ftp.suse.com/pub/projects/security/yaml/ |SUSE packages |
|suse_backports | http://ftp.suse.com/pub/projects/security/yaml/ |SUSE packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|debian_oval | https://www.debian.org/security/oval/ |debian packages |
|debian_oval | https://www.debian.org/security/oval/ |debian packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|redhat | https://access.redhat.com/hydra/rest/securitydata/cve.json |rpm packages |
|redhat | https://access.redhat.com/hydra/rest/securitydata/cve.json |rpm packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|nvd | https://nvd.nist.gov/vuln/data-feeds#JSON_FEED |none |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|gentoo | https://anongit.gentoo.org/git/data/glsa.git |gentoo packages |
|gentoo | https://anongit.gentoo.org/git/data/glsa.git |gentoo packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|openssl | https://www.openssl.org/news/vulnerabilities.xml |openssl |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|ubuntu_usn | https://usn.ubuntu.com/usn-db/database-all.json.bz2 |ubuntu packages |
|ubuntu_usn | https://usn.ubuntu.com/usn-db/database-all.json.bz2 |ubuntu packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|github | https://api.github.com/graphql |maven, .NET, php-composer, pypi packages. ruby gems |
|github | https://api.github.com/graphql |maven, .NET, php-composer, pypi packages. ruby gems |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|msr2019 | https://raw.githubusercontent.com/SAP/project-kb/master/MSR2019/dataset/vulas_db_msr2019_release.csv |maven packages |
|msr2019 | https://raw.githubusercontent.com/SAP/project-kb/master/MSR2019/dataset/vulas_db_msr2019_release.csv |maven packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|apache_httpd | https://httpd.apache.org/security/vulnerabilities-httpd.xml |apache-httpd |
|apache_httpd | https://httpd.apache.org/security/json |apache-httpd |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|kaybee | https://github.com/SAP/project-kb.git |maven packages |
|kaybee | https://github.com/SAP/project-kb.git |maven packages |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
|nginx | http://nginx.org/en/security_advisories.html |nginx |
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/source/command-line-interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Other variations:


``$ ./manage.py purl2cpe --destination <directory``
------------------------------------------
---------------------------------------------------

Dump a mapping of CPEs to PURLs grouped by vulnerability in the ``destination``
directory.
Expand Down
12 changes: 12 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,18 @@

# -- General configuration ---------------------------------------------------

# Ensure there are no invalid URLs
# Use -b linkcheck to check integrity of all external links
nitpicky = True
linkcheck_anchors = False # See: https://github.com/sphinx-doc/sphinx/issues/9016
linkcheck_ignore = [
r"http://localhost:\d+/",
r"http://127.0.0.1:\d+/",
"https://api.github.com/graphql", # Requires auth
"https://anongit.gentoo.org/git/data/glsa.git", # Git only link
"https://www.softwaretestinghelp.com/how-to-write-good-bug-report/", # Cloudflare protection
]

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ resources to help you get started.

.. note::
By contributing to the VulnerableCode project, you agree to the Developer
`Certificate of Origin <http://developercertificate.org/>`_.
`Certificate of Origin <https://developercertificate.org/>`_.


Do Your Homework
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial_add_new_importer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The SPDX license identifiers can be found at https://spdx.org/licenses/.

.. note::
An SPDX license identifier by itself is a valid licence expression. In case you need more complex
expressions, see https://spdx.github.io/spdx-spec/SPDX-license-expressions/
expressions, see https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/

Implement the ``advisory_data`` Method
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down