Skip to content

Commit 71b77af

Browse files
samcunliffesamcunliffe
committed
Merge remote-tracking branch 'origin/main' into packaging_doc_edit
2 parents 816d75e + 8d98058 commit 71b77af

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

+5932
-347
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Bug Report
3+
description: Create a Report to Help us Improve
4+
title: "A one-line description of your problem"
5+
labels:
6+
- bug
7+
assignees:
8+
- paddyroddy
9+
- samcunliffe
10+
body:
11+
- id: describe
12+
type: textarea
13+
attributes:
14+
label: Describe the Bug
15+
description: A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- id: reproduce
19+
type: textarea
20+
attributes:
21+
label: To Reproduce
22+
description: >-
23+
A minimal working example of code to reproduce the unexpected behaviour.
24+
validations:
25+
required: true
26+
- id: expected
27+
type: textarea
28+
attributes:
29+
label: Expected Behaviour
30+
description: >-
31+
A clear and concise description of what you expected to happen.
32+
validations:
33+
required: true
34+
- id: actual
35+
type: textarea
36+
attributes:
37+
label: Actual Behaviour
38+
description: >-
39+
Be a specific and detailed as you can.
40+
Paste any output or stack traces of errors you receive.
41+
validations:
42+
required: true
43+
# - id: version
44+
# type: input
45+
# attributes:
46+
# label: Version In Use
47+
# description: |-
48+
# Can be found by
49+
# ```sh
50+
# python -c "import sleplet; print(sleplet.__version__)"
51+
# ```
52+
# validations:
53+
# required: true
54+
- id: additional
55+
type: textarea
56+
attributes:
57+
label: Additional Context
58+
value: |-
59+
- Cookiecutter version:
60+
- Operating system:
61+
- Python version:
62+
render: Markdown

‎.github/ISSUE_TEMPLATE/config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Documentation
3+
description: How Can We Improve the Documentation
4+
title: "What needs improving in the documentation?"
5+
labels:
6+
- documentation
7+
assignees:
8+
- paddyroddy
9+
- samcunliffe
10+
body:
11+
- id: section
12+
type: textarea
13+
attributes:
14+
label: Which Section of the Documentation Needs Improving?
15+
description: Please provide a link (if it is a specific page).
16+
validations:
17+
required: true
18+
- id: problem
19+
type: textarea
20+
attributes:
21+
label: What Can be Improved About This Section
22+
description: Is it incomplete, incorrect or difficult to understand?
23+
validations:
24+
required: true
25+
- id: suggestions
26+
type: textarea
27+
attributes:
28+
label: How to Improve This Section
29+
description: >-
30+
Do you have any specific suggestions we
31+
could take to improve the documentation?

‎.github/ISSUE_TEMPLATE/feature_request.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Feature Request
3+
description: Suggest a Way to Improve This Project
4+
title: "Feature suggestion: What should be added?"
5+
labels:
6+
- enhancement
7+
assignees:
8+
- paddyroddy
9+
- samcunliffe
10+
body:
11+
- id: problem
12+
type: textarea
13+
attributes:
14+
label: Is Your Feature Request Related to a Problem? Please Describe
15+
description: A clear and concise description of what the problem is.
16+
placeholder: I'm always frustrated when [...]
17+
validations:
18+
required: true
19+
- id: solution
20+
type: textarea
21+
attributes:
22+
label: Describe the Solution You'd Like
23+
description: A clear and concise description of what you want to happen.
24+
validations:
25+
required: true
26+
- id: alternatives
27+
type: textarea
28+
attributes:
29+
label: Describe Alternatives You've Considered
30+
description: >-
31+
A clear and concise description of any alternative
32+
solutions or features you've considered.
33+
- id: additional
34+
type: textarea
35+
attributes:
36+
label: Additional Context
37+
description: >-
38+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Question
3+
description: General Questions About Using the Cookiecutter Template
4+
title: "The title of your question."
5+
labels:
6+
- question
7+
assignees:
8+
- paddyroddy
9+
- samcunliffe
10+
body:
11+
- id: topic
12+
type: dropdown
13+
attributes:
14+
label: What is the Topic of Your Question
15+
description: Please indicate the topic in the title of your question.
16+
options:
17+
- Documentation
18+
- Installation
19+
- Usage
20+
- Website
21+
- Other
22+
validations:
23+
required: true
24+
- id: question
25+
type: textarea
26+
attributes:
27+
label: Add Your Question Below
28+
validations:
29+
required: true

‎.github/ISSUE_TEMPLATE/task.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Task
3+
description: A Task to be Completed
4+
title: "Task: What needs to be done?"
5+
labels:
6+
- task
7+
assignees:
8+
- paddyroddy
9+
- samcunliffe
10+
body:
11+
- id: section
12+
type: textarea
13+
attributes:
14+
label: What needs to be done?
15+
description: Please give as much detail as possible.
16+
validations:
17+
required: true

‎.github/ISSUE_TEMPLATE/website.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Website
3+
description: How Can We Improve the Website
4+
title: "Website Improvement:"
5+
labels:
6+
- website
7+
assignees:
8+
- paddyroddy
9+
- samcunliffe
10+
body:
11+
- id: section
12+
type: textarea
13+
attributes:
14+
label: Which Section of the Website Needs Improving?
15+
description: Please provide a link (if it is a specific page).
16+
validations:
17+
required: true
18+
- id: problem
19+
type: textarea
20+
attributes:
21+
label: What Can be Improved About This Section
22+
description: Is it incomplete, incorrect or difficult to understand?
23+
validations:
24+
required: true
25+
- id: suggestions
26+
type: textarea
27+
attributes:
28+
label: How to Improve This Section
29+
description: >-
30+
Do you have any specific suggestions we
31+
could take to improve the website?

‎.github/workflows/links.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919

2020
- name: Link Checker
2121
id: lychee
22-
uses: lycheeverse/lychee-action@v1.9.1
22+
uses: lycheeverse/lychee-action@c053181aa0c3d17606addfe97a9075a32723548a # v1.9.3
2323
with:
2424
# Exclude the image.sc forum (which works) but returns 403 from
2525
# github runners and exclude relative links to other pages. Ignore

‎.github/workflows/linting.yml

+8-6
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ jobs:
1515
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
1616

1717
- name: Cache pre-commit
18-
uses: actions/cache@v4
18+
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4
1919
with:
2020
path: ~/.cache/pre-commit
2121
key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
2222

2323
- name: Set up python
24-
uses: actions/setup-python@v5
24+
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
2525
with:
2626
python-version: "3.x"
2727

@@ -38,13 +38,13 @@ jobs:
3838
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
3939

4040
- name: Cache pre-commit
41-
uses: actions/cache@v4
41+
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4
4242
with:
4343
path: ~/.cache/pre-commit
4444
key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
4545

4646
- name: Set up python
47-
uses: actions/setup-python@v5
47+
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
4848
with:
4949
python-version: "3.x"
5050

@@ -55,5 +55,7 @@ jobs:
5555
run: cookiecutter . --no-input --output-dir cookie-template
5656

5757
- name: Run pre-commit
58-
run: pre-commit run --all-files --color always --verbose
59-
working-directory: cookie-template
58+
run: |-
59+
git add .
60+
pre-commit run --all-files --color always --verbose
61+
working-directory: cookie-template/python-template

‎.github/workflows/pages.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242
cache-version: 0 # Increment this number if you need to re-download cached gems
4343
- name: Setup Pages
4444
id: pages
45-
uses: actions/configure-pages@v4
45+
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4
4646
with:
4747
generator_config_file: docs/_config.yml
4848
- name: Build with Jekyll
@@ -53,7 +53,7 @@ jobs:
5353
JEKYLL_ENV: production
5454
- name: Upload artifact
5555
# Automatically uploads an artifact from the './_site' directory by default
56-
uses: actions/upload-pages-artifact@v2
56+
uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 # v3
5757
with:
5858
path: docs/_site
5959

@@ -67,4 +67,4 @@ jobs:
6767
steps:
6868
- name: Deploy to GitHub Pages
6969
id: deployment
70-
uses: actions/deploy-pages@v3
70+
uses: actions/deploy-pages@87c3283f01cd6fe19a0ab93a23b2f6fcba5a8e42 # v4

‎.github/workflows/test.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ jobs:
2828
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
2929

3030
- name: Cache tox
31-
uses: actions/cache@v4
31+
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4
3232
with:
3333
path: .tox
3434
key: test-${{ hashFiles('pyproject.toml') }}
3535

3636
- name: Set up Python ${{ matrix.python-version }}
37-
uses: actions/setup-python@v5
37+
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
3838
with:
3939
python-version: ${{ matrix.python-version }}
4040
cache: pip

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55

66
#default project path
77
python-template
8+
9+
*.DS_Store

‎.pre-commit-config.yaml

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1+
exclude: ^{{cookiecutter.project_slug}}/
12
repos:
23
- repo: https://github.com/astral-sh/ruff-pre-commit
3-
rev: v0.1.14
4+
rev: v0.1.15
45
hooks:
56
- id: ruff
67
args:
78
- --config=pyproject.toml
8-
exclude: "{{cookiecutter.project_slug}}/src/{{cookiecutter.package_name}}"
99
- id: ruff-format
1010
args:
1111
- --config=pyproject.toml
@@ -17,7 +17,6 @@ repos:
1717
rev: v0.23.1
1818
hooks:
1919
- id: toml-sort-fix
20-
exclude: "{{cookiecutter.project_slug}}/pyproject.toml"
2120
- repo: https://github.com/pre-commit/mirrors-mypy
2221
rev: v1.8.0
2322
hooks:
@@ -26,12 +25,10 @@ repos:
2625
- --config-file=pyproject.toml
2726
additional_dependencies:
2827
- pytest
29-
exclude: "{{cookiecutter.project_slug}}/(src/{{cookiecutter.package_name}}|tests)"
3028
- repo: https://github.com/pre-commit/mirrors-prettier
3129
rev: v3.1.0
3230
hooks:
3331
- id: prettier
34-
exclude: "{{cookiecutter.project_slug}}/.github/workflows/tests.yml"
3532
- repo: https://github.com/pre-commit/pre-commit-hooks
3633
rev: v4.5.0
3734
hooks:
@@ -43,3 +40,12 @@ repos:
4340
args:
4441
- --fix=lf
4542
- id: trailing-whitespace
43+
- repo: https://github.com/python-jsonschema/check-jsonschema
44+
rev: 0.28.0
45+
hooks:
46+
# Schemas taken from https://www.schemastore.org/json/
47+
- id: check-jsonschema
48+
name: "Validate GitHub issue templates"
49+
files: ^\.github/ISSUE_TEMPLATE/.*\.yml$
50+
exclude: ^\.github/ISSUE_TEMPLATE/config\.yml$
51+
args: ["--verbose", "--schemafile", "schemas/github-issue-forms.json"]

0 commit comments

Comments
 (0)