Skip to content

Upgrade docs site requirements to resolve CVE-2026-25645#276

Merged
cigamit merged 1 commit intomainfrom
docs-CVE-2026-25645
Mar 26, 2026
Merged

Upgrade docs site requirements to resolve CVE-2026-25645#276
cigamit merged 1 commit intomainfrom
docs-CVE-2026-25645

Conversation

@cigamit
Copy link
Copy Markdown
Contributor

@cigamit cigamit commented Mar 26, 2026

No description provided.

@cigamit cigamit requested a review from TheWitness March 26, 2026 18:16
@cigamit cigamit self-assigned this Mar 26, 2026
Copilot AI review requested due to automatic review settings March 26, 2026 18:16
@cigamit cigamit added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file SECURITY A security related issue like a CVE specifically labels Mar 26, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the docs site dependency tooling and pinned requirements to address a security vulnerability (CVE referenced in the PR title).

Changes:

  • Simplifies the docs requirements updater to install the latest pip-tools without a pip upper bound.
  • Upgrades multiple pinned dependencies in docs/docsite/requirements.txt.
  • Changes how urllib3 is constrained (now pinned exactly).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/docsite/updater.sh Updates the dependency update script to install pip-tools without pinning pip.
docs/docsite/requirements.txt Bumps pinned docs dependencies (Sphinx, requests stack, etc.) and pins urllib3 to a specific version.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/docsite/updater.sh

# FIXME: https://github.com/jazzband/pip-tools/issues/1558
${venv}/bin/python3 -m pip install -U 'pip<22.0' pip-tools
${venv}/bin/python3 -m pip install -U pip-tools
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

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

Installing an unpinned latest pip-tools can make docs builds non-reproducible and may break unexpectedly if pip-tools introduces behavior changes. Consider pinning pip-tools to a known-good version range (e.g., in a dedicated tooling constraints file) and, if the prior pip<22.0 workaround is no longer needed, leave a short comment explaining what changed (or link to the upstream fix) so future failures are easier to diagnose.

Suggested change
${venv}/bin/python3 -m pip install -U pip-tools
# Pin pip-tools to a known-good range to keep docs builds reproducible.
${venv}/bin/python3 -m pip install -U 'pip-tools>=7.4,<8.0'

Copilot uses AI. Check for mistakes.
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
urllib3>=2.6.3 # CVE-2026-21441
urllib3==2.6.3
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

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

The PR title references CVE-2026-25645, but the diff only shows an urllib3 constraint change and removes the prior inline CVE note (previously referencing a different CVE). Please add a short note in the relevant place (typically the source requirements.in, not the compiled requirements.txt) clarifying which package/version change mitigates CVE-2026-25645 so the fixation is auditable.

Copilot uses AI. Check for mistakes.
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
urllib3>=2.6.3 # CVE-2026-21441
urllib3==2.6.3
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

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

Pinning urllib3 exactly to 2.6.3 prevents automatically receiving future security/patch updates in the 2.6.x line. If the intent is to enforce a minimum patched version (CVE mitigation), prefer constraining this in the input file (requirements.in) as a direct dependency (so it remains stable across re-compiles) and consider a bounded range (e.g., >=2.6.3,<3) rather than an exact pin, unless you specifically require full lockfile-style immutability.

Suggested change
urllib3==2.6.3
urllib3>=2.6.3,<3

Copilot uses AI. Check for mistakes.
@cigamit cigamit merged commit 1667bd0 into main Mar 26, 2026
4 checks passed
@cigamit cigamit deleted the docs-CVE-2026-25645 branch March 26, 2026 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation SECURITY A security related issue like a CVE specifically

Development

Successfully merging this pull request may close these issues.

3 participants