Skip to content

Commit 3819d44

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent 8927e2f commit 3819d44

39 files changed

+1226
-728
lines changed

‎.copier-answers.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 0.9.6
2+
_commit: 1.2.6
33
_src_path: gh:pawamoy/copier-pdm
44
author_email: [email protected]
55
author_fullname: Timothée Mazzucotelli
@@ -8,6 +8,7 @@ copyright_date: '2020'
88
copyright_holder: Timothée Mazzucotelli
99
copyright_holder_email: [email protected]
1010
copyright_license: ISC License
11+
insiders: false
1112
project_description: Load Python objects documentation.
1213
project_name: pytkdocs
1314
python_package_command_line_name: pytkdocs
@@ -16,5 +17,4 @@ python_package_import_name: pytkdocs
1617
repository_name: pytkdocs
1718
repository_namespace: pawamoy
1819
repository_provider: github.com
19-
use_precommit: false
2020

‎.github/FUNDING.yml‎

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

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,61 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: "[BUG] "
5-
labels: ''
6-
assignees: ''
7-
3+
about: Create a bug report to help us improve.
4+
title: "bug: "
5+
labels: unconfirmed
6+
assignees: [pawamoy]
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
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>
1244

13-
**To Reproduce**
14-
Give us an example of Python code or docstrings that trigger the issue.
45+
### Expected behavior
46+
<!-- Please provide a clear and concise description of what you expected to happen. -->
1547

16-
**Expected behavior**
17-
A clear and concise description of what you expected to happen.
48+
### Environment information
49+
<!-- Please run the following command in your repository and paste its output below it,
50+
redacting sensitive information. -->
1851

19-
**Screenshots**
20-
If you are using `pytkdocs` through `mkdocstrings` and if relevant, please attach a screenshot.
52+
```bash
53+
pytkdocs --debug-info # | xclip -selection clipboard
54+
```
2155

22-
**System (please complete the following information):**
23-
- `pytkdocs` version [e.g. 0.2.1]
24-
- Python version: [e.g. 3.8]
25-
- OS: [Windows/Linux]
56+
PASTE OUTPUT HERE
2657

27-
**Additional context**
28-
Add any other context about the problem here.
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/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/pawamoy/pytkdocs/discussions/new?category=q-a
5+
about: Ask and answer questions in the Discussions tab.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
3+
about: Suggest an idea for this project.
4+
title: "feature: "
55
labels: feature
6-
assignees: ''
7-
6+
assignees: pawamoy
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
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 [...]. -->
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
### Describe the solution you'd like
13+
<!-- A clear and concise description of what you want to happen. -->
1514

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
15+
### Describe alternatives you've considered
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1817

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
18+
### Additional context
19+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/workflows/ci.yml‎

Lines changed: 21 additions & 40 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:
@@ -25,32 +23,21 @@ jobs:
2523

2624
steps:
2725
- name: Checkout
28-
uses: actions/checkout@v2
26+
uses: actions/checkout@v4
27+
28+
- name: Fetch all tags
29+
run: git fetch --depth=1 --tags
2930

3031
- name: Set up PDM
31-
uses: pdm-project/setup-pdm@v2.6
32+
uses: pdm-project/setup-pdm@v4
3233
with:
3334
python-version: "3.8"
3435

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)"
40-
41-
- name: Set up cache
42-
uses: actions/cache@v2
43-
with:
44-
path: |
45-
${{ steps.set_variables.outputs.PIP_CACHE }}
46-
${{ steps.set_variables.outputs.PDM_CACHE }}
47-
key: checks-cache
48-
4936
- name: Resolving dependencies
50-
run: pdm lock
37+
run: pdm lock -v --no-cross-platform -G ci-quality
5138

5239
- name: Install dependencies
53-
run: pdm install -G duty -G docs -G quality -G typing -G security -G numpy-style
40+
run: pdm install -G ci-quality
5441

5542
- name: Check if the documentation builds correctly
5643
run: pdm run duty check-docs
@@ -64,48 +51,42 @@ jobs:
6451
- name: Check for vulnerabilities in dependencies
6552
run: pdm run duty check-dependencies
6653

54+
- name: Check for breaking changes in the API
55+
run: pdm run duty check-api
56+
6757
tests:
6858

6959
strategy:
60+
max-parallel: 4
7061
matrix:
7162
os:
7263
- ubuntu-latest
7364
- macos-latest
7465
- windows-latest
7566
python-version:
76-
- "3.7"
7767
- "3.8"
7868
- "3.9"
7969
- "3.10"
80-
- "3.11-dev"
81-
70+
- "3.11"
71+
- "3.12"
8272
runs-on: ${{ matrix.os }}
73+
continue-on-error: ${{ matrix.python-version == '3.12' }}
8374

8475
steps:
8576
- name: Checkout
86-
uses: actions/checkout@v2
77+
uses: actions/checkout@v4
8778

8879
- name: Set up PDM
89-
uses: pdm-project/setup-pdm@v2.6
80+
uses: pdm-project/setup-pdm@v4
9081
with:
9182
python-version: ${{ matrix.python-version }}
83+
allow-python-prereleases: true
9284

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
101-
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 }}
85+
- name: Resolving dependencies
86+
run: pdm lock -v --no-cross-platform -G ci-tests
10687

10788
- name: Install dependencies
108-
run: pdm install --no-editable -G duty -G tests -G numpy-style
89+
run: pdm install --no-editable -G ci-tests
10990

11091
- name: Run the test suite
11192
run: pdm run duty test

‎.github/workflows/release.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: release
2+
3+
on: push
4+
permissions:
5+
contents: write
6+
7+
jobs:
8+
release:
9+
runs-on: ubuntu-latest
10+
if: startsWith(github.ref, 'refs/tags/')
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
- name: Fetch all tags
15+
run: git fetch --depth=1 --tags
16+
- name: Setup Python
17+
uses: actions/setup-python@v4
18+
- name: Install git-changelog
19+
run: pip install git-changelog
20+
- name: Prepare release notes
21+
run: git-changelog --release-notes > release-notes.md
22+
- name: Create release
23+
uses: softprops/action-gh-release@v1
24+
with:
25+
body_path: release-notes.md

‎.gitignore‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.idea/
2+
.vscode/
23
__pycache__/
34
*.py[cod]
45
dist/
@@ -11,6 +12,9 @@ pip-wheel-metadata/
1112
.mypy_cache/
1213
site/
1314
pdm.lock
14-
.pdm.toml
15+
pdm.toml
16+
.pdm-plugins/
17+
.pdm-python
1518
__pypackages__/
1619
.venv/
20+
.cache/

‎.gitpod.dockerfile‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
FROM gitpod/workspace-full
22
USER gitpod
33
ENV PIP_USER=no
4-
ENV PYTHON_VERSIONS=
54
RUN pip3 install pipx; \
65
pipx install pdm; \
76
pipx ensurepath

0 commit comments

Comments
 (0)