Skip to content

Conversation

@webknjaz
Copy link
Member

@webknjaz webknjaz commented Nov 7, 2025

This is needed because Dependabot and other GH Code Security tooling reads the file header to determine the Python version to use.

Currently, it's unable to bump pip in the docs env [1] supposedly due to this.

Contributor checklist
  • Included tests for the changes.
  • A change note is created in changelog.d/ (see changelog.d/README.md for instructions) or the PR text says "no changelog needed".
Maintainer checklist
  • If no changelog is needed, apply the bot:chronographer:skip label.
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

This is needed because Dependabot and other GH Code Security tooling
reads the file header to determine the Python version to use.

Currently, it's unable to bump pip in the docs env [[1]] supposedly
due to this.

[1]: https://github.com/jazzband/pip-tools/security/dependabot/22
@webknjaz webknjaz added this to the later milestone Nov 7, 2025
@webknjaz webknjaz requested review from Copilot and sirosen November 7, 2025 14:29
@webknjaz webknjaz added docs Documentation related maintenance Related to maintenance processes labels Nov 7, 2025
@webknjaz webknjaz marked this pull request as ready for review November 7, 2025 14:29
@webknjaz webknjaz enabled auto-merge November 7, 2025 14:29
Copy link

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

This PR updates the autogenerated comment in the documentation requirements file to reflect that it was compiled using Python 3.13 instead of Python 3.11. This is purely a metadata update in a comment, with no functional code changes.

  • Updated pip-compile comment to indicate Python 3.13 was used for requirements generation

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

@sirosen
Copy link
Member

sirosen commented Nov 7, 2025

Can we also set base_python for the tox env which updates this file?

@webknjaz
Copy link
Member Author

webknjaz commented Nov 7, 2025

Can we also set base_python for the tox env which updates this file?

Not sure. base_python has proven difficult to maintain in the past. Plus it might not be available for contributors while Sphinx would be perfectly functional on other versions otherwise. I think that having the version set for the job in GHA already achieves what we want.

If anything, we could work on a warning emitted from a toxfile.py on failure with a hint if the current Python version differs from what's in GHA/RTD configs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:skip docs Documentation related maintenance Related to maintenance processes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants