FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Merge pull request #2243 from mwtoews/uv-sync · gitpython-developers/GitPython@cf43820 · GitHub

  1. gitpython-developers
  2. GitPython

Repository navigation

Commit cf43820

Browse files
Byron
authored
Merge pull request #2243 from mwtoews/uv-sync
Move [doc] extra to a PEP 735 dependency group; add uv-sync CI check
2 parents 7609492 + 6b63633 commit cf43820

7 files changed

Lines changed: 67 additions & 17 deletions

File tree

‎.github/workflows/dependencies.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,18 @@ jobs:
4040
else
4141
pytest -o addopts= -v smmap/smmap/test
4242
fi
43+
uv-sync:
44+
runs-on: ubuntu-latest
45+
steps:
46+
- uses: actions/checkout@v7
47+
with:
48+
persist-credentials: false
49+
50+
- name: Install uv
51+
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
52+
with:
53+
enable-cache: false
54+
version: "0.12.13" # Released on 2026-09-10
55+
56+
# Ensure that dependencies and dependency groups are consistent and resolvable.
57+
- run: uv sync --all-extras --all-groups --dry-run

‎.github/workflows/pythonpackage.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,5 +173,5 @@ jobs:
173173
- name: Documentation
174174
if: matrix.build-docs
175175
run: |
176-
pip install '.[doc]'
176+
pip install --group doc
177177
make -C doc html

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,6 @@ output.txt
5252

5353
# Files created by OSS-Fuzz when running locally
5454
fuzz_*.pkg.spec
55+
56+
# Lock files created by uv, pixi, pipenv and others
57+
*.lock

‎.readthedocs.yaml‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ build:
1313
# nodejs: "20"
1414
# rust: "1.70"
1515
# golang: "1.20"
16+
jobs:
17+
install:
18+
- python -m pip install --upgrade --no-cache-dir pip setuptools
19+
- python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir --group doc .
1620

1721
# Build documentation in the "doc/" directory with Sphinx.
1822
sphinx:
@@ -24,13 +28,3 @@ sphinx:
2428

2529
# Optionally build your docs in additional formats such as PDF and ePub.
2630
formats: all
27-
28-
# Optional but recommended, declare the Python requirements required
29-
# to build your documentation.
30-
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
31-
python:
32-
install:
33-
- method: pip
34-
path: .
35-
extra_requirements:
36-
- doc

‎AGENTS.md‎

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,42 @@
1+
# Contribution guidelines
2+
3+
Before starting work, read and follow [CONTRIBUTING.md](CONTRIBUTING.md),
4+
including the [Prevent agent impersonation](CONTRIBUTING.md#prevent-agent-impersonation)
5+
section governing identification when communicating through a person's account.
6+
17
# Commit messages
28

3-
Every commit must have a descriptive title and a substantive body. Title-only
4-
commit messages are not acceptable.
9+
Follow Conventional Commits for every commit. Every commit must have a
10+
descriptive title and a substantive body. Title-only commit messages are not
11+
acceptable.
12+
13+
## Formatting
14+
15+
Write commit messages in Markdown and assume readers view them with syntax
16+
highlighting. Enclose code identifiers, package and module names, file paths,
17+
and shell commands in backticks. Use Markdown whenever it helps readers
18+
understand or navigate the prose.
19+
20+
## Titles
21+
22+
- Every title must use the form `type: description` or
23+
`type(scope): description`.
24+
- Use `feat:` for user-visible features and `fix:` for user-visible fixes.
25+
- Use appropriate prefixes for other changes, such as `docs:`, `test:`, `ci:`,
26+
`build:`, `refactor:`, `perf:`, `style:`, or `chore:`.
27+
- Breaking changes must use `!` immediately before the colon, for example
28+
`feat!:`, `refactor!:`, or a scoped form such as `fix(repo)!:`.
29+
- Optionally scope a commit to the affected component, for example `fix(repo):`.
30+
31+
Example titles:
32+
33+
- `feat: add support for a new Git option`
34+
- `fix(repo): handle bare repositories correctly`
35+
- `build!: drop support for an older Python version`
36+
- `ci: add an independent documentation build`
37+
- `refactor(repo): simplify repository initialization`
38+
39+
## Body
540

641
The body must explain the problem or motivation, what changed, and why the
742
chosen approach addresses it. Include relevant behavior before and after the

‎doc/requirements.txt‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎pyproject.toml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,20 @@ dynamic = ["license", "version", "dependencies", "optional-dependencies"]
4040
"Source code" = "https://github.com/gitpython-developers/GitPython"
4141
"Documentation" = "https://gitpython.readthedocs.io/en/stable/"
4242

43+
[dependency-groups]
44+
doc = [
45+
'sphinx >=7.4.7,<8 ; python_version >= "3.9"',
46+
"sphinx-autodoc-typehints",
47+
"sphinx-rtd-theme",
48+
]
49+
4350
[tool.setuptools]
4451
include-package-data = true
4552

4653
[tool.setuptools.dynamic]
4754
version = {file = "VERSION"}
4855
dependencies = {file = "requirements.txt"}
4956
optional-dependencies."test" = {file = "test-requirements.txt"}
50-
optional-dependencies."doc" = {file = "doc/requirements.txt"}
5157

5258
[tool.setuptools.packages.find]
5359
include = ["git", "git.*"]

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL