sphinx-github-changelog 2.3.0__tar.gz → 2.3.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/renovate.json5 +1 -1
  2. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/workflows/autofix.yml +6 -3
  3. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/workflows/ci.yml +16 -13
  4. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/workflows/coverage-comment.yml +1 -1
  5. sphinx_github_changelog-2.3.1/.pre-commit-config.yaml +59 -0
  6. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/PKG-INFO +3 -2
  7. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/pyproject.toml +3 -1
  8. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/conftest.py +1 -1
  9. sphinx_github_changelog-2.3.1/uv.lock +1399 -0
  10. sphinx_github_changelog-2.3.0/.pre-commit-config.yaml +0 -59
  11. sphinx_github_changelog-2.3.0/uv.lock +0 -1132
  12. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.editorconfig +0 -0
  13. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/CODEOWNERS +0 -0
  14. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
  15. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.github/release.yml +0 -0
  16. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.gitignore +0 -0
  17. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/.readthedocs.yml +0 -0
  18. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/CHANGELOG.rst +0 -0
  19. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/CODE_OF_CONDUCT.rst +0 -0
  20. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/CONTRIBUTING.rst +0 -0
  21. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/LICENSE +0 -0
  22. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/README.rst +0 -0
  23. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/docs/Makefile +0 -0
  24. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/docs/conduct.rst +0 -0
  25. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/docs/conf.py +0 -0
  26. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/docs/contributing.rst +0 -0
  27. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/docs/index.rst +0 -0
  28. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/scripts/README.md +0 -0
  29. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/scripts/docs +0 -0
  30. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/scripts/lint +0 -0
  31. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/scripts/tests +0 -0
  32. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/__init__.py +0 -0
  33. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/changelog.py +0 -0
  34. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/config.py +0 -0
  35. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/credentials.py +0 -0
  36. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/exceptions.py +0 -0
  37. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/github_releases.py +0 -0
  38. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/setup.py +0 -0
  39. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/sphinx_github_changelog/urls.py +0 -0
  40. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/__init__.py +0 -0
  41. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/acceptance/__init__.py +0 -0
  42. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/acceptance/cassettes/test_all/test_build.yaml +0 -0
  43. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/acceptance/cassettes/test_all/test_build_404.yaml +0 -0
  44. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/acceptance/changelog.html +0 -0
  45. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/acceptance/test_all.py +0 -0
  46. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/roots/test-404/conf.py +0 -0
  47. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/roots/test-404/index.rst +0 -0
  48. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/roots/test-all/conf.py +0 -0
  49. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/roots/test-all/index.rst +0 -0
  50. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/roots/test-error/conf.py +0 -0
  51. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/roots/test-error/index.rst +0 -0
  52. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/unit/__init__.py +0 -0
  53. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/unit/test_changelog.py +0 -0
  54. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/unit/test_config.py +0 -0
  55. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/unit/test_git.py +0 -0
  56. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/unit/test_github_releases.py +0 -0
  57. {sphinx_github_changelog-2.3.0 → sphinx_github_changelog-2.3.1}/tests/unit/test_urls.py +0 -0
@@ -1,5 +1,5 @@
1
1
  {
2
- extends: ["config:recommended", ":enablePreCommit"],
2
+ extends: ["config:recommended", ":enablePreCommit", "helpers:pinGitHubActionDigests"],
3
3
  schedule: ["before 4am on Saturday"],
4
4
  labels: ["PR type: dependencies 🤖"],
5
5
  minimumReleaseAge: "5 days",
@@ -1,6 +1,9 @@
1
1
  name: autofix.ci
2
2
  on: [pull_request]
3
3
 
4
+ env:
5
+ UV_FROZEN: "true"
6
+
4
7
  permissions:
5
8
  contents: read
6
9
 
@@ -9,13 +12,13 @@ jobs:
9
12
  name: Autofix
10
13
  runs-on: ubuntu-latest
11
14
  steps:
12
- - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
15
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
13
16
  with:
14
17
  persist-credentials: false
15
18
 
16
19
  - name: Set up UV
17
20
  id: setup-uv
18
- uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
21
+ uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
19
22
  with:
20
23
  enable-cache: false
21
24
 
@@ -23,7 +26,7 @@ jobs:
23
26
  run: uv sync --all-groups
24
27
 
25
28
  - name: Run prek
26
- uses: j178/prek-action@bdca6f102f98e2b4c7029491a53dfd366469e33d # v2.0.4
29
+ uses: j178/prek-action@44924fe9ef4a6f88253c4b6b1bf11c689d3ce53d # v3.1.0
27
30
 
28
31
  - name: Commits back to branch if necessary
29
32
  uses: autofix-ci/action@c5b2d67aa2274e7b5a18224e8171550871fc7e4a # v1.3.4
@@ -8,6 +8,9 @@ on:
8
8
  tags:
9
9
  - "*"
10
10
 
11
+ env:
12
+ UV_FROZEN: "true"
13
+
11
14
  permissions:
12
15
  contents: read
13
16
 
@@ -16,13 +19,13 @@ jobs:
16
19
  name: linting
17
20
  runs-on: ubuntu-latest
18
21
  steps:
19
- - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
22
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
20
23
  with:
21
24
  persist-credentials: false
22
25
 
23
26
  - name: Set up UV
24
27
  id: setup-uv
25
- uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
28
+ uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
26
29
  with:
27
30
  enable-cache: false
28
31
 
@@ -30,26 +33,26 @@ jobs:
30
33
  run: uv sync --all-groups
31
34
 
32
35
  - name: Run prek
33
- uses: j178/prek-action@bdca6f102f98e2b4c7029491a53dfd366469e33d # v2.0.4
36
+ uses: j178/prek-action@44924fe9ef4a6f88253c4b6b1bf11c689d3ce53d # v3.1.0
34
37
  env:
35
38
  PREK_SKIP: no-commit-to-branch
36
39
 
37
40
  tests:
38
41
  strategy:
39
42
  matrix:
40
- python_version: ["3.11", "3.12", "3.13", "3.14"]
43
+ python_version: ["3.11", "3.12", "3.13", "3.14", "3.15"]
41
44
 
42
45
  name: "py${{ matrix.python_version }}"
43
46
  runs-on: ubuntu-latest
44
47
 
45
48
  steps:
46
- - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
49
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
47
50
  with:
48
51
  persist-credentials: false
49
52
 
50
53
  - name: Set up UV
51
54
  id: setup-uv
52
- uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
55
+ uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
53
56
  with:
54
57
  python-version: ${{ matrix.python_version }}
55
58
  enable-cache: false
@@ -60,7 +63,7 @@ jobs:
60
63
  COVERAGE_FILE: ".coverage.${{ matrix.python_version }}"
61
64
 
62
65
  - name: Store coverage file
63
- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
66
+ uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
64
67
  with:
65
68
  name: coverage-${{ matrix.python_version }}
66
69
  path: .coverage.${{ matrix.python_version }}
@@ -74,11 +77,11 @@ jobs:
74
77
  contents: write
75
78
  pull-requests: write
76
79
  steps:
77
- - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
80
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
78
81
  with:
79
82
  persist-credentials: true
80
83
 
81
- - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
84
+ - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
82
85
  with:
83
86
  pattern: coverage-*
84
87
  merge-multiple: true
@@ -88,12 +91,12 @@ jobs:
88
91
  pipx run coverage combine
89
92
 
90
93
  - name: Display coverage
91
- uses: ewjoachim/python-coverage-comment-action@63f52f4fbbffada6e8dee8ec432de7e01df9ba79 # v3.41
94
+ uses: ewjoachim/python-coverage-comment-action@e5fb2218463c3377f3504b0c5b5646ed53da7a2f # v4.5
92
95
  with:
93
96
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
94
97
 
95
98
  - name: Store Pull Request comment to be posted
96
- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
99
+ uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
97
100
  with:
98
101
  name: python-coverage-comment-action
99
102
  path: python-coverage-comment-action.txt
@@ -112,7 +115,7 @@ jobs:
112
115
  - tests
113
116
  - lint
114
117
  steps:
115
- - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
118
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
116
119
  with:
117
120
  persist-credentials: false
118
121
 
@@ -120,4 +123,4 @@ jobs:
120
123
  run: pipx run uv build
121
124
 
122
125
  - name: Publish package distributions to PyPI
123
- uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
126
+ uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
@@ -20,7 +20,7 @@ jobs:
20
20
  # DO NOT run actions/checkout here, for securitity reasons
21
21
  # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
22
22
  - name: Post comment
23
- uses: ewjoachim/python-coverage-comment-action@63f52f4fbbffada6e8dee8ec432de7e01df9ba79 # v3.41
23
+ uses: ewjoachim/python-coverage-comment-action@e5fb2218463c3377f3504b0c5b5646ed53da7a2f # v4.5
24
24
  with:
25
25
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26
26
  GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}
@@ -0,0 +1,59 @@
1
+ repos:
2
+ - repo: builtin
3
+ hooks:
4
+ # File names
5
+ - id: check-case-conflict
6
+ # File formats
7
+ - id: pretty-format-json
8
+ - id: check-json
9
+ - id: check-toml
10
+ - id: check-yaml
11
+ # Executables
12
+ - id: check-executables-have-shebangs
13
+ - id: check-shebang-scripts-are-executable
14
+ # Git shenanigans
15
+ - id: check-merge-conflict
16
+ - id: check-added-large-files
17
+ # Whitespace
18
+ - id: end-of-file-fixer
19
+ - id: trailing-whitespace
20
+ - id: mixed-line-ending
21
+ - id: no-commit-to-branch
22
+
23
+ - repo: local
24
+ hooks:
25
+ - id: ruff-check
26
+ name: ruff check
27
+ entry: uv run --group lint ruff check --force-exclude --fix --unsafe-fixes --show-fixes
28
+ language: system
29
+ types_or: [python, pyi]
30
+ require_serial: true
31
+
32
+ - id: ruff-format
33
+ name: ruff format
34
+ entry: uv run --group lint ruff format --force-exclude
35
+ language: system
36
+ types_or: [python, pyi]
37
+ require_serial: true
38
+
39
+ - id: uv-lock
40
+ name: uv-lock
41
+ entry: env UV_FROZEN=false uv lock
42
+ language: system
43
+ files: ^(uv\.lock|pyproject\.toml|uv\.toml)$
44
+ pass_filenames: false
45
+
46
+ - id: basedpyright
47
+ name: basedpyright
48
+ entry: uv run --group lint basedpyright
49
+ language: system
50
+ types_or: [python, pyi]
51
+ require_serial: true
52
+
53
+ - id: zizmor
54
+ name: zizmor
55
+ entry: uv run --group lint zizmor --no-progress --fix=all
56
+ language: system
57
+ types: [yaml]
58
+ files: (\.github/(workflows/.*|dependabot\.ya?ml))|(action\.ya?ml)$
59
+ require_serial: true
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.5
2
2
  Name: sphinx-github-changelog
3
- Version: 2.3.0
3
+ Version: 2.3.1
4
4
  Summary: Build a sphinx changelog from GitHub Releases
5
5
  Project-URL: Homepage, https://sphinx-github-changelog.readthedocs.io/en/latest/
6
6
  Project-URL: Repository, https://github.com/ewjoachim/sphinx-github-changelog
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.11
15
15
  Classifier: Programming Language :: Python :: 3.12
16
16
  Classifier: Programming Language :: Python :: 3.13
17
17
  Classifier: Programming Language :: Python :: 3.14
18
+ Classifier: Programming Language :: Python :: 3.15
18
19
  Classifier: Topic :: Documentation
19
20
  Classifier: Topic :: Documentation :: Sphinx
20
21
  Classifier: Typing :: Typed
@@ -28,6 +28,7 @@ classifiers = [
28
28
  "Programming Language :: Python :: 3.12",
29
29
  "Programming Language :: Python :: 3.13",
30
30
  "Programming Language :: Python :: 3.14",
31
+ "Programming Language :: Python :: 3.15",
31
32
  ]
32
33
  dependencies = ["docutils", "myst-parser>=5.1.0", "httpx", "Sphinx", "tenacity"]
33
34
 
@@ -45,17 +46,18 @@ dev = [
45
46
  "pytest-mock",
46
47
  "pytest-httpx",
47
48
  "pytest-recording",
48
- "basedpyright",
49
49
  "pytest-subprocess>=1.6.0",
50
50
  "beautifulsoup4>=4.14.3",
51
51
  "html5lib>=1.1",
52
52
  ]
53
53
  docs = ["sphinx-rtd-theme"]
54
54
  types = ["types-requests", "types-docutils"]
55
+ lint = ["basedpyright", "ruff", "zizmor"]
55
56
 
56
57
  [tool.uv]
57
58
  default-groups = ["dev", "docs"]
58
59
  exclude-newer = "5 days"
60
+ exclude-newer-package = { certifi = false }
59
61
 
60
62
  [tool.basedpyright]
61
63
  exclude = ["tests", ".venv", "scripts", ".github"]
@@ -98,6 +98,6 @@ def temp_git(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
98
98
  """Fixture to create a temporary git repository."""
99
99
  repo = tmp_path / "repo"
100
100
  repo.mkdir()
101
- subprocess.run(["git", "init", "--initial-branch=main"], cwd=repo)
101
+ subprocess.run(["git", "init", "--initial-branch=main"], cwd=repo, check=True)
102
102
  monkeypatch.chdir(repo)
103
103
  return repo