Skip to content

Commit c972f6d

Browse files
pawamoypawamoy
committed
build: Provide no-op handler for non-insiders contributors
1 parent 111e8c0 commit c972f6d

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

+3367
-2
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.0.0
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: '2023'
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-shell
14+
language: Shell
15+
project_description: A shell scripts/libraries handler for mkdocstrings.
16+
project_name: mkdocstrings-shell
17+
public_release: false
18+
python_package_distribution_name: mkdocstrings-shell
19+
python_package_import_name: shell
20+
repository_name: shell
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/bug_report.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.shell.debug # | xclip -selection clipboard
54+
```
55+
56+
PASTE 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/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/shell/discussions/new?category=q-a
5+
about: Ask and answer questions in the Discussions tab.

‎.github/ISSUE_TEMPLATE/feature_request.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/workflows/ci.yml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
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+
29+
- name: Fetch all tags
30+
run: git fetch --depth=1 --tags
31+
32+
- name: Set up Python
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: "3.11"
36+
37+
- name: Install uv
38+
run: pip install uv
39+
40+
- name: Install dependencies
41+
run: make setup
42+
43+
- name: Check if the documentation builds correctly
44+
run: make check-docs
45+
46+
- name: Check the code quality
47+
run: make check-quality
48+
49+
- name: Check if the code is correctly typed
50+
run: make check-types
51+
52+
- name: Check for vulnerabilities in dependencies
53+
run: make check-dependencies
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.9"},
70+
{"python-version": "3.10"},
71+
{"python-version": "3.11"},
72+
{"python-version": "3.12"}
73+
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
74+
else
75+
echo 'jobs=[]' >> $GITHUB_OUTPUT
76+
fi
77+
78+
tests:
79+
80+
needs: exclude-test-jobs
81+
strategy:
82+
matrix:
83+
os:
84+
- ubuntu-latest
85+
- macos-latest
86+
- windows-latest
87+
python-version:
88+
- "3.8"
89+
- "3.9"
90+
- "3.10"
91+
- "3.11"
92+
- "3.12"
93+
exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
94+
runs-on: ${{ matrix.os }}
95+
continue-on-error: ${{ matrix.python-version == '3.12' }}
96+
97+
steps:
98+
- name: Checkout
99+
uses: actions/checkout@v4
100+
101+
- name: Set up Python
102+
uses: actions/setup-python@v5
103+
with:
104+
python-version: ${{ matrix.python-version }}
105+
allow-prereleases: true
106+
107+
- name: Install uv
108+
run: pip install uv
109+
110+
- name: Install dependencies
111+
run: make setup
112+
113+
- name: Run the test suite
114+
run: make test

‎.github/workflows/release.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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 build
19+
if: github.repository_owner == 'pawamoy-insiders'
20+
run: python -m pip install build
21+
- name: Build dists
22+
if: github.repository_owner == 'pawamoy-insiders'
23+
run: python -m build
24+
- name: Upload dists artifact
25+
uses: actions/upload-artifact@v4
26+
if: github.repository_owner == 'pawamoy-insiders'
27+
with:
28+
name: shell-insiders
29+
path: ./dist/*
30+
- name: Install git-changelog
31+
if: github.repository_owner != 'pawamoy-insiders'
32+
run: pip install git-changelog
33+
- name: Prepare release notes
34+
if: github.repository_owner != 'pawamoy-insiders'
35+
run: git-changelog --release-notes > release-notes.md
36+
- name: Create release with assets
37+
uses: softprops/action-gh-release@v1
38+
if: github.repository_owner == 'pawamoy-insiders'
39+
with:
40+
files: ./dist/*
41+
- name: Create release
42+
uses: softprops/action-gh-release@v1
43+
if: github.repository_owner != 'pawamoy-insiders'
44+
with:
45+
body_path: release-notes.md

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# editors
2+
.idea/
3+
.vscode/
4+
5+
# python
6+
*.egg-info/
7+
*.py[cod]
8+
.venv/
9+
.venvs/
10+
/build/
11+
/dist/
12+
13+
# tools
14+
.coverage*
15+
/.pdm-build/
16+
/htmlcov/
17+
/site/
18+
19+
# cache
20+
.cache/
21+
.pytest_cache/
22+
.mypy_cache/
23+
.ruff_cache/
24+
__pycache__/

‎.gitpod.dockerfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
FROM gitpod/workspace-full
2+
USER gitpod
3+
ENV PIP_USER=no
4+
RUN pip3 install pipx; \
5+
pipx install uv; \
6+
pipx ensurepath

0 commit comments

Comments
 (0)