Skip to content

Commit c1eba62

Browse files
pawamoypawamoy
committed
feat: Generate project with gh:mkdocstrings/handler-template Copier template
0 parents  commit c1eba62

Some content is hidden

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

56 files changed

+3212
-0
lines changed

‎.copier-answers.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: 1.2.1
3+
_src_path: gh:mkdocstrings/handler-template
4+
author_email: [email protected]
5+
author_fullname: Timothée Mazzucotelli
6+
author_username: pawamoy
7+
copyright_date: '2024'
8+
copyright_holder: Timothée Mazzucotelli
9+
copyright_holder_email: [email protected]
10+
copyright_license: ISC License
11+
insiders: true
12+
insiders_email: [email protected]
13+
insiders_repository_name: mkdocstrings-csharp
14+
language: C#
15+
project_description: A C# handler for mkdocstrings.
16+
project_name: mkdocstrings-csharp
17+
public_release: false
18+
python_package_distribution_name: mkdocstrings-csharp
19+
python_package_import_name: csharp
20+
repository_name: csharp
21+
repository_namespace: mkdocstrings
22+
repository_provider: github.com
23+

‎.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: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
github: pawamoy
2+
ko_fi: pawamoy
3+
polar: pawamoy
4+
custom:
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.csharp.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/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/csharp/discussions/new?category=q-a
5+
about: Ask and answer questions in the Discussions tab.

‎.github/workflows/ci.yml

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
pull_request:
6+
branches:
7+
- main
8+
9+
defaults:
10+
run:
11+
shell: bash
12+
13+
env:
14+
LANG: en_US.utf-8
15+
LC_ALL: en_US.utf-8
16+
PYTHONIOENCODING: UTF-8
17+
PYTHON_VERSIONS: ""
18+
19+
jobs:
20+
21+
quality:
22+
23+
runs-on: ubuntu-latest
24+
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
30+
fetch-tags: true
31+
32+
- name: Setup Python
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: "3.12"
36+
37+
- name: Setup uv
38+
uses: astral-sh/setup-uv@v3
39+
with:
40+
enable-cache: true
41+
cache-dependency-glob: pyproject.toml
42+
43+
- name: Install dependencies
44+
run: make setup
45+
46+
- name: Check if the documentation builds correctly
47+
run: make check-docs
48+
49+
- name: Check the code quality
50+
run: make check-quality
51+
52+
- name: Check if the code is correctly typed
53+
run: make check-types
54+
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
81+
82+
tests:
83+
84+
needs: exclude-test-jobs
85+
strategy:
86+
matrix:
87+
os:
88+
- ubuntu-latest
89+
- macos-latest
90+
- windows-latest
91+
python-version:
92+
- "3.9"
93+
- "3.10"
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) }}
102+
runs-on: ${{ matrix.os }}
103+
continue-on-error: ${{ matrix.python-version == '3.14' }}
104+
105+
steps:
106+
- name: Checkout
107+
uses: actions/checkout@v4
108+
with:
109+
fetch-depth: 0
110+
fetch-tags: true
111+
112+
- name: Setup Python
113+
uses: actions/setup-python@v5
114+
with:
115+
python-version: ${{ matrix.python-version }}
116+
allow-prereleases: true
117+
118+
- name: Setup uv
119+
uses: astral-sh/setup-uv@v3
120+
with:
121+
enable-cache: true
122+
cache-dependency-glob: pyproject.toml
123+
cache-suffix: py${{ matrix.python-version }}
124+
125+
- name: Install dependencies
126+
env:
127+
UV_RESOLUTION: ${{ matrix.resolution }}
128+
run: make setup
129+
130+
- name: Run the test suite
131+
run: make test

‎.github/workflows/release.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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+
with:
15+
fetch-depth: 0
16+
fetch-tags: true
17+
- name: Setup Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: "3.12"
21+
- name: Setup uv
22+
uses: astral-sh/setup-uv@v3
23+
- name: Build dists
24+
if: github.repository_owner == 'pawamoy-insiders'
25+
run: uv tool run --from build pyproject-build
26+
- name: Upload dists artifact
27+
uses: actions/upload-artifact@v4
28+
if: github.repository_owner == 'pawamoy-insiders'
29+
with:
30+
name: csharp-insiders
31+
path: ./dist/*
32+
- name: Prepare release notes
33+
if: github.repository_owner != 'pawamoy-insiders'
34+
run: uv tool run git-changelog --release-notes > release-notes.md
35+
- name: Create release with assets
36+
uses: softprops/action-gh-release@v2
37+
if: github.repository_owner == 'pawamoy-insiders'
38+
with:
39+
files: ./dist/*
40+
- name: Create release
41+
uses: softprops/action-gh-release@v2
42+
if: github.repository_owner != 'pawamoy-insiders'
43+
with:
44+
body_path: release-notes.md

0 commit comments

Comments
 (0)