Skip to content

Commit 7f14614

Browse files
committed
chore: Template upgrade
1 parent afd7ef0 commit 7f14614

File tree

11 files changed

+82
-26
lines changed

11 files changed

+82
-26
lines changed

.copier-answers.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier.
2-
_commit: 1.9.0
2+
_commit: 1.11.1
33
_src_path: gh:pawamoy/copier-uv
44
author_email: [email protected]
55
author_fullname: Timothée Mazzucotelli
@@ -8,7 +8,6 @@ copyright_date: '2023'
88
copyright_holder: Timothée Mazzucotelli
99
copyright_holder_email: [email protected]
1010
copyright_license: ISC
11-
insiders: false
1211
project_description: Output API docs to Markdown using Griffe.
1312
project_name: griffe2md
1413
python_package_command_line_name: griffe2md

.github/pull_request_template.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
<!-- Help reviewers by letting them know whether AI was used to create this PR. -->
33

44
- [ ] I did not use AI
5-
- [ ] I used AI and thorougly reviewed every code/docs change
5+
- [ ] I used AI and thoroughly reviewed every code/docs change
66

77
### Description of the change
88
<!-- Quick sentence for small changes, longer description for more impacting changes. -->
99

10-
1110
### Relevant resources
1211
<!-- Link to any relevant GitHub issue, PR or discussion, section in online docs, etc. -->
1312

.github/workflows/ci.yml

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@ name: ci
22

33
on:
44
push:
5+
branches:
6+
- main
7+
- test-me-*
58
pull_request:
69
branches:
710
- main
811

12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
15+
916
defaults:
1017
run:
1118
shell: bash
@@ -14,13 +21,30 @@ env:
1421
LANG: en_US.utf-8
1522
LC_ALL: en_US.utf-8
1623
PYTHONIOENCODING: UTF-8
24+
PYTHONWARNDEFAULTENCODING: "1"
1725
PYTHON_VERSIONS: ""
1826

1927
jobs:
2028

2129
quality:
30+
strategy:
31+
matrix:
32+
os:
33+
- ubuntu-latest
34+
- macos-latest
35+
- windows-latest
36+
python-version:
37+
- "3.10"
38+
- "3.14"
39+
include:
40+
- os: ubuntu-latest
41+
python-version: "3.11"
42+
- os: ubuntu-latest
43+
python-version: "3.12"
44+
- os: ubuntu-latest
45+
python-version: "3.13"
2246

23-
runs-on: ubuntu-latest
47+
runs-on: ${{ matrix.os }}
2448

2549
steps:
2650
- name: Checkout
@@ -30,9 +54,9 @@ jobs:
3054
fetch-tags: true
3155

3256
- name: Setup Python
33-
uses: actions/setup-python@v5
57+
uses: actions/setup-python@v6
3458
with:
35-
python-version: "3.12"
59+
python-version: ${{ matrix.python-version }}
3660

3761
- name: Setup uv
3862
uses: astral-sh/setup-uv@v5
@@ -57,6 +81,7 @@ jobs:
5781

5882
- name: Store objects inventory for tests
5983
uses: actions/upload-artifact@v4
84+
if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' }}
6085
with:
6186
name: objects.inv
6287
path: site/objects.inv
@@ -72,12 +97,12 @@ jobs:
7297
- macos-latest
7398
- windows-latest
7499
python-version:
75-
- "3.9"
76100
- "3.10"
77101
- "3.11"
78102
- "3.12"
79103
- "3.13"
80104
- "3.14"
105+
- "3.15"
81106
resolution:
82107
- highest
83108
- lowest-direct
@@ -87,7 +112,7 @@ jobs:
87112
- os: windows-latest
88113
resolution: lowest-direct
89114
runs-on: ${{ matrix.os }}
90-
continue-on-error: ${{ matrix.python-version == '3.14' }}
115+
continue-on-error: true
91116

92117
steps:
93118
- name: Checkout
@@ -97,7 +122,7 @@ jobs:
97122
fetch-tags: true
98123

99124
- name: Setup Python
100-
uses: actions/setup-python@v5
125+
uses: actions/setup-python@v6
101126
with:
102127
python-version: ${{ matrix.python-version }}
103128
allow-prereleases: true

.github/workflows/release.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ jobs:
1515
fetch-depth: 0
1616
fetch-tags: true
1717
- name: Setup Python
18-
uses: actions/setup-python@v5
18+
uses: actions/setup-python@v6
1919
with:
20-
python-version: "3.12"
20+
python-version: "3.13"
2121
- name: Setup uv
2222
uses: astral-sh/setup-uv@v5
2323
- name: Prepare release notes
@@ -26,3 +26,4 @@ jobs:
2626
uses: softprops/action-gh-release@v2
2727
with:
2828
body_path: release-notes.md
29+

.github/workflows/sponsors.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Update sponsors
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * *'
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
update-readme:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
- name: Update README and create PR
19+
uses: pawamoy/readme-insert@main
20+
with:
21+
markup-url: https://pawamoy.github.io/sponsors.txt
22+
start-marker: '<!-- sponsors-start -->'
23+
end-marker: '<!-- sponsors-end -->'
24+
commit-message: 'chore: Update sponsors section in README'
25+
pr-title: 'chore: Update sponsors section in README'
26+
pr-body: 'This PR updates the sponsors section in the README file.'

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,8 @@ docstring_style = "sphinx"
5050
```
5151

5252
See [the documentation](https://mkdocstrings.github.io/griffe2md/reference/griffe2md/config/#griffe2md.config.ConfigDict) for reference.
53+
54+
## Sponsors
55+
56+
<!-- sponsors-start -->
57+
<!-- sponsors-end -->

config/pytest.ini

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ testpaths =
1010
# action:message_regex:warning_class:module_regex:line
1111
filterwarnings =
1212
error
13+
default::EncodingWarning
14+
error::EncodingWarning:griffe2md
1315
# TODO: remove once pytest-xdist 4 is released
1416
ignore:.*rsyncdir:DeprecationWarning:xdist
1517
ignore:.*slated for removal in Python:DeprecationWarning:.*

docs/.overrides/main.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{% extends "base.html" %}
22

33
{% block announce %}
4-
4+
<strong>Fund this project</strong> through
5+
<a href="https://github.com/sponsors/pawamoy"><strong>sponsorship</strong></a>
6+
<span class="twemoji heart pulse">
7+
{% include ".icons/octicons/heart-fill-16.svg" %}
8+
</span> &mdash;
59
Follow
610
<strong>@pawamoy</strong> on
711
<a rel="me" href="https://fosstodon.org/@pawamoy">

duties.py

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ def docs_deploy(ctx: Context) -> None:
134134
with material_insiders() as insiders:
135135
if not insiders:
136136
ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
137-
ctx.run(tools.mkdocs.gh_deploy(), title="Deploying documentation")
137+
ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
138138

139139

140140
@duty
@@ -181,7 +181,7 @@ def release(ctx: Context, version: str = "") -> None:
181181
ctx.run("false", title="A version must be provided")
182182
ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
183183
ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
184-
ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
184+
ctx.run(f"git tag -m '' -a {version}", title="Tagging commit", pty=PTY)
185185
ctx.run("git push", title="Pushing commits", pty=False)
186186
ctx.run("git push --tags", title="Pushing tags", pty=False)
187187

@@ -195,18 +195,14 @@ def coverage(ctx: Context) -> None:
195195

196196

197197
@duty(nofail=PY_VERSION == PY_DEV)
198-
def test(ctx: Context, *cli_args: str, match: str = "") -> None: # noqa: PT028
199-
"""Run the test suite.
200-
201-
Parameters:
202-
match: A pytest expression to filter selected tests.
203-
"""
198+
def test(ctx: Context, *cli_args: str) -> None:
199+
"""Run the test suite."""
204200
os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}"
201+
os.environ["PYTHONWARNDEFAULTENCODING"] = "1"
205202
ctx.run(
206203
tools.pytest(
207204
"tests",
208205
config_file="config/pytest.ini",
209-
select=match,
210206
color="yes",
211207
).add_args("-n", "auto", *cli_args),
212208
title=pyprefix("Running tests"),

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ authors = [{name = "Timothée Mazzucotelli", email = "[email protected]"}]
99
license = "ISC"
1010
license-files = ["LICENSE"]
1111
readme = "README.md"
12-
requires-python = ">=3.9"
12+
requires-python = ">=3.10"
1313
keywords = []
1414
dynamic = ["version"]
1515
classifiers = [
@@ -18,7 +18,6 @@ classifiers = [
1818
"Programming Language :: Python",
1919
"Programming Language :: Python :: 3",
2020
"Programming Language :: Python :: 3 :: Only",
21-
"Programming Language :: Python :: 3.9",
2221
"Programming Language :: Python :: 3.10",
2322
"Programming Language :: Python :: 3.11",
2423
"Programming Language :: Python :: 3.12",

0 commit comments

Comments
 (0)