Skip to content

Commit 5f5f9ed

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent a0131c6 commit 5f5f9ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+2597
-1090
lines changed

‎.copier-answers.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 0.1.0
2+
_commit: 1.2.1
33
_src_path: gh:mkdocstrings/handler-template
4-
author_email: pawamoy@pm.me
4+
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli
66
author_username: pawamoy
77
copyright_date: '2022'
88
copyright_holder: Timothée Mazzucotelli
9-
copyright_holder_email: pawamoy@pm.me
9+
copyright_holder_email: dev@pawamoy.fr
1010
copyright_license: ISC License
11-
language: javascript
11+
insiders: true
12+
insiders_email: insiders@pawamoy.fr
13+
insiders_repository_name: mkdocstrings-javascript
14+
language: Javascript
1215
project_description: Javascript handler for mkdocstrings.
1316
project_name: mkdocstrings-javascript
17+
public_release: false
1418
python_package_distribution_name: mkdocstrings-javascript
1519
python_package_import_name: javascript
1620
repository_name: javascript

‎.envrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
PATH_add scripts

‎.github/FUNDING.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
github:
2-
- pawamoy
1+
github: pawamoy
32
ko_fi: pawamoy
4-
liberapay: pawamoy
5-
patreon: pawamoy
3+
polar: pawamoy
64
custom:
7-
- https://www.paypal.me/pawamoy
5+
- https://www.paypal.me/pawamoy

‎.github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve.
4+
title: "bug: "
5+
labels: unconfirmed
6+
assignees: [pawamoy]
7+
---
8+
9+
### Description of the bug
10+
<!-- Please provide a clear and concise description of what the bug is. -->
11+
12+
### To Reproduce
13+
<!-- Please provide a Minimal Reproducible Example (MRE) if possible.
14+
Try to boil down the problem to a few lines of code.
15+
Your code should run by simply copying and pasting it.
16+
17+
Example:
18+
19+
```
20+
git clone https://github.com/username/repro
21+
cd repro
22+
python -m venv .venv
23+
. .venv/bin/activate
24+
pip install -r requirements.txt
25+
... # command or code showing the issue
26+
```
27+
-->
28+
29+
```
30+
WRITE MRE / INSTRUCTIONS HERE
31+
```
32+
33+
### Full traceback
34+
<!-- Please provide the full error message / traceback if any, by pasting it in the code block below.
35+
No screenshots! -->
36+
37+
<details><summary>Full traceback</summary>
38+
39+
```python
40+
PASTE TRACEBACK HERE
41+
```
42+
43+
</details>
44+
45+
### Expected behavior
46+
<!-- Please provide a clear and concise description of what you expected to happen. -->
47+
48+
### Environment information
49+
<!-- Please run the following command in your repository and paste its output below it,
50+
redacting sensitive information. -->
51+
52+
```bash
53+
python -m mkdocstrings_handlers.javascript.debug # | xclip -selection clipboard
54+
```
55+
56+
PASTE MARKDOWN OUTPUT HERE
57+
58+
### Additional context
59+
<!-- Add any other relevant context about the problem here,
60+
like links to other issues or pull requests, screenshots, etc.
61+
-->

‎.github/ISSUE_TEMPLATE/2-feature.md

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

‎.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/ISSUE_TEMPLATE/bug_report.md

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

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: I have a question / I need help
4+
url: https://github.com/mkdocstrings/javascript/discussions/new?category=q-a
5+
about: Ask and answer questions in the Discussions tab.

‎.github/ISSUE_TEMPLATE/feature_request.md

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

‎.github/workflows/ci.yml

Lines changed: 69 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@ name: ci
22

33
on:
44
push:
5-
branches:
6-
- master
75
pull_request:
86
branches:
9-
- master
7+
- main
108

119
defaults:
1210
run:
@@ -16,6 +14,7 @@ env:
1614
LANG: en_US.utf-8
1715
LC_ALL: en_US.utf-8
1816
PYTHONIOENCODING: UTF-8
17+
PYTHON_VERSIONS: ""
1918

2019
jobs:
2120

@@ -25,87 +24,108 @@ jobs:
2524

2625
steps:
2726
- name: Checkout
28-
uses: actions/checkout@v2
29-
30-
- name: Set up PDM
31-
uses: pdm-project/setup-pdm@v2.6
27+
uses: actions/checkout@v4
3228
with:
33-
python-version: "3.8"
34-
35-
- name: Set cache variables
36-
id: set_variables
37-
run: |
38-
echo "::set-output name=PIP_CACHE::$(pip cache dir)"
39-
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
29+
fetch-depth: 0
30+
fetch-tags: true
4031

41-
- name: Set up cache
42-
uses: actions/cache@v2
32+
- name: Setup Python
33+
uses: actions/setup-python@v5
4334
with:
44-
path: |
45-
${{ steps.set_variables.outputs.PIP_CACHE }}
46-
${{ steps.set_variables.outputs.PDM_CACHE }}
47-
key: checks-cache
35+
python-version: "3.12"
4836

49-
- name: Resolving dependencies
50-
run: pdm lock
37+
- name: Setup uv
38+
uses: astral-sh/setup-uv@v3
39+
with:
40+
enable-cache: true
41+
cache-dependency-glob: pyproject.toml
5142

5243
- name: Install dependencies
53-
run: pdm install -G duty -G docs -G quality -G typing -G security
44+
run: make setup
5445

5546
- name: Check if the documentation builds correctly
56-
run: pdm run duty check-docs
47+
run: make check-docs
5748

5849
- name: Check the code quality
59-
run: pdm run duty check-quality
50+
run: make check-quality
6051

6152
- name: Check if the code is correctly typed
62-
run: pdm run duty check-types
53+
run: make check-types
6354

64-
- name: Check for vulnerabilities in dependencies
65-
run: pdm run duty check-dependencies
55+
- name: Check for breaking changes in the API
56+
run: make check-api
57+
58+
exclude-test-jobs:
59+
runs-on: ubuntu-latest
60+
outputs:
61+
jobs: ${{ steps.exclude-jobs.outputs.jobs }}
62+
steps:
63+
- id: exclude-jobs
64+
run: |
65+
if ${{ github.repository_owner == 'pawamoy-insiders' }}; then
66+
echo 'jobs=[
67+
{"os": "macos-latest"},
68+
{"os": "windows-latest"},
69+
{"python-version": "3.10"},
70+
{"python-version": "3.11"},
71+
{"python-version": "3.12"},
72+
{"python-version": "3.13"},
73+
{"python-version": "3.14"}
74+
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
75+
else
76+
echo 'jobs=[
77+
{"os": "macos-latest", "resolution": "lowest-direct"},
78+
{"os": "windows-latest", "resolution": "lowest-direct"}
79+
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
80+
fi
6681
6782
tests:
6883

84+
needs: exclude-test-jobs
6985
strategy:
7086
matrix:
7187
os:
7288
- ubuntu-latest
7389
- macos-latest
7490
- windows-latest
7591
python-version:
76-
- "3.7"
77-
- "3.8"
7892
- "3.9"
7993
- "3.10"
80-
- "3.11-dev"
81-
94+
- "3.11"
95+
- "3.12"
96+
- "3.13"
97+
- "3.14"
98+
resolution:
99+
- highest
100+
- lowest-direct
101+
exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
82102
runs-on: ${{ matrix.os }}
103+
continue-on-error: ${{ matrix.python-version == '3.14' }}
83104

84105
steps:
85106
- name: Checkout
86-
uses: actions/checkout@v2
107+
uses: actions/checkout@v4
108+
with:
109+
fetch-depth: 0
110+
fetch-tags: true
87111

88-
- name: Set up PDM
89-
uses: pdm-project/setup-pdm@v2.6
112+
- name: Setup Python
113+
uses: actions/setup-python@v5
90114
with:
91115
python-version: ${{ matrix.python-version }}
116+
allow-prereleases: true
92117

93-
- name: Set cache variables
94-
id: set_variables
95-
run: |
96-
echo "::set-output name=PIP_CACHE::$(pip cache dir)"
97-
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
98-
99-
- name: Set up cache
100-
uses: actions/cache@v2
118+
- name: Setup uv
119+
uses: astral-sh/setup-uv@v3
101120
with:
102-
path: |
103-
${{ steps.set_variables.outputs.PIP_CACHE }}
104-
${{ steps.set_variables.outputs.PDM_CACHE }}
105-
key: tests-cache-${{ runner.os }}-${{ matrix.python-version }}
121+
enable-cache: true
122+
cache-dependency-glob: pyproject.toml
123+
cache-suffix: py${{ matrix.python-version }}
106124

107125
- name: Install dependencies
108-
run: pdm install -G duty -G tests
126+
env:
127+
UV_RESOLUTION: ${{ matrix.resolution }}
128+
run: make setup
109129

110130
- name: Run the test suite
111-
run: pdm run duty test
131+
run: make test

0 commit comments

Comments
 (0)