Skip to content

Commit 924ecd8

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent da216b0 commit 924ecd8

26 files changed

Lines changed: 493 additions & 480 deletions

‎.copier-answers.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 1.1.0
2+
_commit: 1.4.0
33
_src_path: gh:pawamoy/copier-uv
44
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli

.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ PASTE TRACEBACK HERE
5353
python -m mkdocstrings.debug # | xclip -selection clipboard
5454
```
5555

56-
PASTE OUTPUT HERE
56+
PASTE MARKDOWN OUTPUT HERE
5757

5858
### Additional context
5959
<!-- Add any other relevant context about the problem here,

.github/ISSUE_TEMPLATE/feature_request.md renamed to .github/ISSUE_TEMPLATE/2-feature.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/3-docs.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Documentation update
3+
about: Point at unclear, missing or outdated documentation.
4+
title: "docs: "
5+
labels: docs
6+
assignees: pawamoy
7+
---
8+
9+
### Is something unclear, missing or outdated in our documentation?
10+
<!-- A clear and concise description of what the documentation issue is. Ex. I can't find an explanation on feature [...]. -->
11+
12+
### Relevant code snippets
13+
<!-- If the documentation issue is related to code, please provide relevant code snippets. -->
14+
15+
### Link to the relevant documentation section
16+
<!-- Add a link to the relevant section of our documentation, or any addition context. -->

‎.github/ISSUE_TEMPLATE/4-change.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Change request
3+
about: Suggest any other kind of change for this project.
4+
title: "change: "
5+
assignees: pawamoy
6+
---
7+
8+
### Is your change request related to a problem? Please describe.
9+
<!-- A clear and concise description of what the problem is. -->
10+
11+
### Describe the solution you'd like
12+
<!-- A clear and concise description of what you want to happen. -->
13+
14+
### Describe alternatives you've considered
15+
<!-- A clear and concise description of any alternative solutions you've considered. -->
16+
17+
### Additional context
18+
<!-- Add any other context or screenshots about the change request here. -->

‎.github/workflows/ci.yml‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@ jobs:
5050
- name: Check if the code is correctly typed
5151
run: make check-types
5252

53-
- name: Check for vulnerabilities in dependencies
54-
run: make check-dependencies
55-
5653
- name: Check for breaking changes in the API
5754
run: make check-api
5855

@@ -70,10 +67,14 @@ jobs:
7067
{"python-version": "3.9"},
7168
{"python-version": "3.10"},
7269
{"python-version": "3.11"},
73-
{"python-version": "3.12"}
70+
{"python-version": "3.12"},
71+
{"python-version": "3.13"}
7472
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
7573
else
76-
echo 'jobs=[]' >> $GITHUB_OUTPUT
74+
echo 'jobs=[
75+
{"os": "macos-latest", "resolution": "lowest-direct"},
76+
{"os": "windows-latest", "resolution": "lowest-direct"}
77+
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
7778
fi
7879
7980
tests:
@@ -91,9 +92,13 @@ jobs:
9192
- "3.10"
9293
- "3.11"
9394
- "3.12"
95+
- "3.13"
96+
resolution:
97+
- highest
98+
- lowest-direct
9499
exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
95100
runs-on: ${{ matrix.os }}
96-
continue-on-error: ${{ matrix.python-version == '3.12' }}
101+
continue-on-error: ${{ matrix.python-version == '3.13' }}
97102

98103
steps:
99104
- name: Checkout
@@ -109,6 +114,8 @@ jobs:
109114
run: pip install uv
110115

111116
- name: Install dependencies
117+
env:
118+
UV_RESOLUTION: ${{ matrix.resolution }}
112119
run: make setup
113120

114121
- name: Run the test suite

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,11 @@ Run `make help` to see all the available actions!
3636
3737
## Tasks
3838
39-
This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
40-
A Makefile is also provided. The Makefile will try to run certain tasks
41-
on multiple Python versions. If for some reason you don't want to run the task
42-
on multiple Python versions, you run the task directly with `make run duty TASK`.
43-
44-
The Makefile detects if a virtual environment is activated,
45-
so `make` will work the same with the virtualenv activated or not.
39+
The entry-point to run commands and tasks is the `make` Python script,
40+
located in the `scripts` directory. Try running `make` to show the available commands and tasks.
41+
The *commands* do not need the Python dependencies to be installed,
42+
while the *tasks* do.
43+
The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
4644
4745
If you work in VSCode, we provide
4846
[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)

‎Makefile‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# This Makefile is just here to allow auto-completion in the terminal.
44

55
actions = \
6+
allrun \
67
changelog \
78
check \
89
check-api \
9-
check-dependencies \
1010
check-docs \
1111
check-quality \
1212
check-types \
@@ -16,6 +16,7 @@ actions = \
1616
docs-deploy \
1717
format \
1818
help \
19+
multirun \
1920
release \
2021
run \
2122
setup \
@@ -24,4 +25,4 @@ actions = \
2425

2526
.PHONY: $(actions)
2627
$(actions):
27-
@bash scripts/make "$@"
28+
@python scripts/make "$@"

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# mkdocstrings
22

33
[![ci](https://github.com/mkdocstrings/mkdocstrings/workflows/ci/badge.svg)](https://github.com/mkdocstrings/mkdocstrings/actions?query=workflow%3Aci)
4-
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/)
4+
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/)
55
[![pypi version](https://img.shields.io/pypi/v/mkdocstrings.svg)](https://pypi.org/project/mkdocstrings/)
66
[![conda version](https://img.shields.io/conda/vn/conda-forge/mkdocstrings)](https://anaconda.org/conda-forge/mkdocstrings)
7-
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/mkdocstrings)
7+
[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/mkdocstrings)
88
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#mkdocstrings:gitter.im)
99

1010
Automatic documentation from sources, for [MkDocs](https://www.mkdocs.org/).

‎config/pytest.ini‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
[pytest]
22
python_files =
33
test_*.py
4-
*_test.py
5-
tests.py
64
addopts =
75
--cov
86
--cov-config config/coverage.ini

0 commit comments

Comments
 (0)