Skip to content

Commit 20477c6

Browse files
davidismdavidism
committed
update project files (#5457)
* update pre-commit hooks * add devcontainer * show url in publish environment * update actions versions * separate typing job * use dependabot grouped updates ignore upload/download-artifact until slsa updates * use sphinx.ext.extlinks instead of sphinx-issues * update editorconfig * update gitignore * update .readthedocs.yaml * license is txt, readme is md * use pyproject.toml and flit_core instead of setuptools add typed classifier add pyright config simplify urls * tox builds docs in place * add tox env to update all dev dependencies * update issue and pr templates * simplify matrix
1 parent e491223 commit 20477c6

26 files changed

+280
-379
lines changed

‎.devcontainer/devcontainer.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "pallets/jinja",
3+
"image": "mcr.microsoft.com/devcontainers/python:3",
4+
"customizations": {
5+
"vscode": {
6+
"settings": {
7+
"python.defaultInterpreterPath": "${workspaceFolder}/.venv",
8+
"python.terminal.activateEnvInCurrentTerminal": true,
9+
"python.terminal.launchArgs": [
10+
"-X",
11+
"dev"
12+
]
13+
}
14+
}
15+
},
16+
"onCreateCommand": ".devcontainer/on-create-command.sh"
17+
}

‎.devcontainer/on-create-command.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/bin/bash
2+
set -e
3+
python3 -m venv --upgrade-deps .venv
4+
. .venv/bin/activate
5+
pip install -r requirements/dev.txt
6+
pip install -e .
7+
pre-commit install --install-hooks

‎.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ end_of_line = lf
99
charset = utf-8
1010
max_line_length = 88
1111

12-
[*.{yml,yaml,json,js,css,html}]
12+
[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]
1313
indent_size = 2

‎.flake8

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ about: Report a bug in Jinja (not other projects which depend on Jinja)
44
---
55

66
<!--
7-
This issue tracker is a tool to address bugs in Jinja itself. Please
8-
use Pallets Discord or Stack Overflow for questions about your own code.
7+
This issue tracker is a tool to address bugs in Jinja itself. Please use
8+
GitHub Discussions or the Pallets Discord for questions about your own code.
99
1010
Replace this comment with a clear outline of what the bug is.
1111
-->

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Security issue
4-
url: [email protected]
5-
about: Do not report security issues publicly. Email our security contact.
6-
- name: Questions
7-
url: https://stackoverflow.com/questions/tagged/Jinja?tab=Frequent
8-
about: Search for and ask questions about your code on Stack Overflow.
9-
- name: Questions and discussions
3+
- name: Questions on Discussions
4+
url: https://github.com/pallets/jinja/discussions/
5+
about: Ask questions about your own code on the Discussions tab.
6+
- name: Questions on Chat
107
url: https://discord.gg/pallets
11-
about: Discuss questions about your code on our Discord chat.
8+
about: Ask questions about your own code on our Discord chat.

‎.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ about: Suggest a new feature for Jinja
55

66
<!--
77
Replace this comment with a description of what the feature should do.
8-
Include details such as links relevant specs or previous discussions.
8+
Include details such as links to relevant specs or previous discussions.
99
-->
1010

1111
<!--
1212
Replace this comment with an example of the problem which this feature
13-
would resolve. Is this problem solvable without changes to Jinja,
14-
such as by subclassing or using an extension?
13+
would resolve. Is this problem solvable without changes to Jinja, such
14+
as by subclassing or using an extension?
1515
-->

‎.github/dependabot.yml

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "github-actions"
4-
directory: "/"
5-
schedule:
6-
interval: "monthly"
7-
day: "monday"
8-
time: "16:00"
9-
timezone: "UTC"
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: monthly
7+
ignore:
8+
# slsa depends on upload/download v3
9+
- dependency-name: actions/upload-artifact
10+
versions: '>= 4'
11+
- dependency-name: actions/download-artifact
12+
versions: '>= 4'
13+
groups:
14+
github-actions:
15+
patterns:
16+
- '*'
17+
- package-ecosystem: pip
18+
directory: /requirements/
19+
schedule:
20+
interval: monthly
21+
groups:
22+
python-requirements:
23+
patterns:
24+
- '*'

‎.github/pull_request_template.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
11
<!--
2-
Before opening a PR, open a ticket describing the issue or feature the PR will address. Follow the steps in CONTRIBUTING.rst.
2+
Before opening a PR, open a ticket describing the issue or feature the
3+
PR will address. An issue is not required for fixing typos in
4+
documentation, or other simple non-code changes.
35
4-
Replace this comment with a description of the change. Describe how it addresses the linked ticket.
6+
Replace this comment with a description of the change. Describe how it
7+
addresses the linked ticket.
58
-->
69

710
<!--
8-
Link to relevant issues or previous PRs, one per line. Use "fixes" to automatically close an issue.
9-
-->
11+
Link to relevant issues or previous PRs, one per line. Use "fixes" to
12+
automatically close an issue.
1013
11-
- fixes #<issue number>
14+
fixes #<issue number>
15+
-->
1216

1317
<!--
14-
Ensure each step in CONTRIBUTING.rst is complete by adding an "x" to each box below.
18+
Ensure each step in CONTRIBUTING.rst is complete, especially the following:
1519
16-
If only docs were changed, these aren't relevant and can be removed.
20+
- Add tests that demonstrate the correct behavior of the change. Tests
21+
should fail without the change.
22+
- Add or update relevant docs, in the docs folder and in code.
23+
- Add an entry in CHANGES.rst summarizing the change and linking to the issue.
24+
- Add `.. versionchanged::` entries in any relevant code docs.
1725
-->
18-
19-
Checklist:
20-
21-
- [ ] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
22-
- [ ] Add or update relevant docs, in the docs folder and in code.
23-
- [ ] Add an entry in `CHANGES.rst` summarizing the change and linking to the issue.
24-
- [ ] Add `.. versionchanged::` entries in any relevant code docs.
25-
- [ ] Run `pre-commit` hooks and fix any issues.
26-
- [ ] Run `pytest` and `tox`, no tests failed.

‎.github/workflows/lock.yaml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
name: 'Lock threads'
2-
# Lock closed issues that have not received any further activity for
3-
# two weeks. This does not close open issues, only humans may do that.
4-
# We find that it is easier to respond to new issues with fresh examples
5-
# rather than continuing discussions on old issues.
1+
name: Lock inactive closed issues
2+
# Lock closed issues that have not received any further activity for two weeks.
3+
# This does not close open issues, only humans may do that. It is easier to
4+
# respond to new issues with fresh examples rather than continuing discussions
5+
# on old issues.
66

77
on:
88
schedule:
99
- cron: '0 0 * * *'
10-
1110
permissions:
1211
issues: write
1312
pull-requests: write
14-
1513
concurrency:
1614
group: lock
17-
1815
jobs:
1916
lock:
2017
runs-on: ubuntu-latest
2118
steps:
22-
- uses: dessant/lock-threads@c1b35aecc5cdb1a34539d14196df55838bb2f836
19+
- uses: dessant/lock-threads@1bf7ec25051fe7c00bdd17e6a7cf3d7bfb7dc771 # v5.0.1
2320
with:
2421
issue-inactive-days: 14
2522
pr-inactive-days: 14
23+
discussion-inactive-days: 14

0 commit comments

Comments
 (0)