Skip to content

Commit 6a45da8

Browse files
committed
chore: Template upgrade
1 parent 48b92fb commit 6a45da8

25 files changed

Lines changed: 725 additions & 634 deletions

.copier-answers.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 0.9.0
3-
_src_path: gh:pawamoy/copier-pdm.git
2+
_commit: 0.15.21
3+
_src_path: gh:pawamoy/copier-pdm
44
author_email: pawamoy@pm.me
55
author_fullname: Timothée Mazzucotelli
66
author_username: pawamoy
77
copyright_date: '2019'
88
copyright_holder: Timothée Mazzucotelli
99
copyright_holder_email: pawamoy@pm.me
1010
copyright_license: ISC License
11+
insiders: false
1112
project_description: Automatically link across pages in MkDocs.
1213
project_name: mkdocs-autorefs
13-
python_package_command_line_name: mkdocs-autorefs
14+
python_package_command_line_name: ''
1415
python_package_distribution_name: mkdocs-autorefs
1516
python_package_import_name: mkdocs_autorefs
1617
repository_name: autorefs
1718
repository_namespace: mkdocstrings
1819
repository_provider: github.com
19-
use_precommit: false
2020

.github/workflows/ci.yml

Lines changed: 16 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,18 @@ jobs:
2323

2424
steps:
2525
- name: Checkout
26-
uses: actions/checkout@v2
26+
uses: actions/checkout@v3
2727

2828
- name: Set up PDM
29-
uses: pdm-project/setup-pdm@v2.6
29+
uses: pdm-project/setup-pdm@v3
3030
with:
3131
python-version: "3.8"
3232

33-
- name: Set cache variables
34-
id: set_variables
35-
run: |
36-
echo "::set-output name=PIP_CACHE::$(pip cache dir)"
37-
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
38-
39-
- name: Set up cache
40-
uses: actions/cache@v2
41-
with:
42-
path: |
43-
${{ steps.set_variables.outputs.PIP_CACHE }}
44-
${{ steps.set_variables.outputs.PDM_CACHE }}
45-
key: checks-cache
46-
4733
- name: Resolving dependencies
48-
run: pdm lock
34+
run: pdm lock -v --no-cross-platform -G ci-quality
4935

5036
- name: Install dependencies
51-
run: pdm install -G duty -G docs -G quality -G typing -G security
37+
run: pdm install -G ci-quality
5238

5339
- name: Check if the documentation builds correctly
5440
run: pdm run duty check-docs
@@ -62,48 +48,41 @@ jobs:
6248
- name: Check for vulnerabilities in dependencies
6349
run: pdm run duty check-dependencies
6450

51+
- name: Check for breaking changes in the API
52+
run: pdm run duty check-api
53+
6554
tests:
6655

6756
strategy:
57+
max-parallel: 4
6858
matrix:
6959
os:
7060
- ubuntu-latest
7161
- macos-latest
7262
- windows-latest
7363
python-version:
74-
- "3.7"
7564
- "3.8"
7665
- "3.9"
7766
- "3.10"
78-
- "3.11-dev"
79-
67+
- "3.11"
68+
- "3.12"
8069
runs-on: ${{ matrix.os }}
70+
continue-on-error: ${{ matrix.python-version == '3.12' }}
8171

8272
steps:
8373
- name: Checkout
84-
uses: actions/checkout@v2
74+
uses: actions/checkout@v3
8575

8676
- name: Set up PDM
87-
uses: pdm-project/setup-pdm@v2.6
77+
uses: pdm-project/setup-pdm@v3
8878
with:
8979
python-version: ${{ matrix.python-version }}
9080

91-
- name: Set cache variables
92-
id: set_variables
93-
run: |
94-
echo "::set-output name=PIP_CACHE::$(pip cache dir)"
95-
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
96-
97-
- name: Set up cache
98-
uses: actions/cache@v2
99-
with:
100-
path: |
101-
${{ steps.set_variables.outputs.PIP_CACHE }}
102-
${{ steps.set_variables.outputs.PDM_CACHE }}
103-
key: tests-cache-${{ runner.os }}-${{ matrix.python-version }}
81+
- name: Resolving dependencies
82+
run: pdm lock -v --no-cross-platform -G ci-tests
10483

10584
- name: Install dependencies
106-
run: pdm install --no-editable -G duty -G tests
85+
run: pdm install --no-editable -G ci-tests
10786

10887
- name: Run the test suite
10988
run: pdm run duty test

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ pip-wheel-metadata/
1111
.python-version
1212
site/
1313
pdm.lock
14-
.pdm.toml
14+
pdm.toml
15+
.pdm-plugins/
16+
.pdm-python
1517
__pypackages__/
1618
.venv/
19+
.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

CODE_OF_CONDUCT.md

Lines changed: 105 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,73 +2,132 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, gender identity and expression, level of experience,
9-
nationality, personal appearance, race, religion, or sexual identity and
10-
orientation.
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
1114

1215
## Our Standards
1316

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
1619

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
2227

23-
Examples of unacceptable behavior by participants include:
28+
Examples of unacceptable behavior include:
2429

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
2833
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
3136
* Other conduct which could reasonably be considered inappropriate in a
3237
professional setting
3338

34-
## Our Responsibilities
39+
## Enforcement Responsibilities
3540

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
3945

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
4550

4651
## Scope
4752

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
5458

5559
## Enforcement
5660

5761
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at pawamoy@pm.me. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
62+
reported to the community leaders responsible for enforcement at
63+
pawamoy@pm.me.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
6387

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
67114

68115
## Attribution
69116

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at [http://contributor-covenant.org/version/1/4][version]
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
72133

73-
[homepage]: http://contributor-covenant.org
74-
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)