Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validate GitHub issue templates #307

Merged
merged 4 commits into from
Feb 19, 2024
Merged

Validate GitHub issue templates #307

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8456bd8
Validate GitHub issue templates
dstansby Feb 16, 2024
105734c
Add issue template validation to package tempalte
dstansby Feb 19, 2024
359e5b4
Fix render value in issue template
dstansby Feb 19, 2024
15ca923
Use version number for check-jsonschema hook
dstansby Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ body:
- Cookiecutter version:
- Operating system:
- Python version:
render: markdown
render: Markdown
9 changes: 9 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,12 @@ repos:
args:
- --fix=lf
- id: trailing-whitespace
- repo: https://github.com/python-jsonschema/check-jsonschema
rev: cb934cfd6d2eea1aed7b20e4e9e6339d5952322c # 0.28.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume renovate will use this syntax in the future. How does this play with pre-commit autoupdate?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😢 pre-commit autoupdate doesn't like it, and just changes it back to a version number. So I've switched the SHAs to version numbers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I thought that might be the case. The pre-commit maintainer is pretty stubborn, too, so he likely won't change the format.

hooks:
# Schemas taken from https://www.schemastore.org/json/
- id: check-jsonschema
name: "Validate GitHub issue templates"
files: ^\.github/ISSUE_TEMPLATE/.*\.yml$
exclude: ^\.github/ISSUE_TEMPLATE/config\.yml$
args: ["--verbose", "--schemafile", "schemas/github-issue-forms.json"]
Loading