Skip to content

Commit 8c24455

Browse files
ulgensulgens
authored
Added pre-commit configuration
1 parent 8232a87 commit 8c24455

31 files changed

+271
-195
lines changed

‎.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
trim_trailing_whitespace = true
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 4
10+
11+
[*.py]
12+
max_line_length = 88
13+
14+
[*.{html,json}]
15+
indent_style = space
16+
indent_size = 2
17+
trim_trailing_whitespace = false
18+
19+
[*.{scss,js}]
20+
indent_style = space
21+
indent_size = 4

‎.github/workflows/docker-publish.yml

+35-35
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
11
name: Create and publish a Docker image
22

33
on:
4-
push:
5-
branches: ['main']
4+
push:
5+
branches: ["main"]
66

77
env:
8-
REGISTRY: ghcr.io
9-
IMAGE_NAME: ${{ github.repository }}
8+
REGISTRY: ghcr.io
9+
IMAGE_NAME: ${{ github.repository }}
1010

1111
jobs:
12-
build-and-push-image:
13-
runs-on: ubuntu-latest
14-
permissions:
15-
contents: read
16-
packages: write
12+
build-and-push-image:
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: read
16+
packages: write
1717

18-
steps:
19-
- name: Checkout repository
20-
uses: actions/checkout@v2
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v2
2121

22-
- name: Log in to the Container registry
23-
uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
24-
with:
25-
registry: ${{ env.REGISTRY }}
26-
username: ${{ github.actor }}
27-
password: ${{ secrets.GITHUB_TOKEN }}
22+
- name: Log in to the Container registry
23+
uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
24+
with:
25+
registry: ${{ env.REGISTRY }}
26+
username: ${{ github.actor }}
27+
password: ${{ secrets.GITHUB_TOKEN }}
2828

29-
- name: Extract metadata (tags, labels) for Docker
30-
id: meta
31-
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
32-
with:
33-
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
34-
flavor: |
35-
latest=true
36-
tags: |
37-
type=ref,event=branch
38-
type=sha
29+
- name: Extract metadata (tags, labels) for Docker
30+
id: meta
31+
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
32+
with:
33+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
34+
flavor: |
35+
latest=true
36+
tags: |
37+
type=ref,event=branch
38+
type=sha
3939
40-
- name: Build and push Docker image
41-
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
42-
with:
43-
context: .
44-
push: true
45-
tags: ${{ steps.meta.outputs.tags }}
46-
labels: ${{ steps.meta.outputs.labels }}
40+
- name: Build and push Docker image
41+
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
42+
with:
43+
context: .
44+
push: true
45+
tags: ${{ steps.meta.outputs.tags }}
46+
labels: ${{ steps.meta.outputs.labels }}

‎.github/workflows/docker-test-build.yml

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
name: Docker test build
22

33
on:
4-
pull_request:
5-
push:
6-
branches:
7-
- main
4+
pull_request:
5+
push:
6+
branches:
7+
- main
88

99
concurrency:
10-
group: ${{ github.workflow }}-${{ github.ref }}
11-
cancel-in-progress: true
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
1212

1313
permissions:
14-
contents: read
14+
contents: read
1515

1616
jobs:
17-
build-image:
18-
runs-on: ubuntu-latest
17+
build-image:
18+
runs-on: ubuntu-latest
1919

20-
# steps taken (and trimmed) from docker-publish.yml
21-
steps:
22-
- name: Checkout repository
23-
uses: actions/checkout@v2
20+
# steps taken (and trimmed) from docker-publish.yml
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v2
2424

25-
- name: Build and push Docker image
26-
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
27-
with:
28-
context: .
29-
push: false
25+
- name: Build and push Docker image
26+
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
27+
with:
28+
context: .
29+
push: false

‎.github/workflows/linters.yml

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
name: Linters
22

33
on:
4-
pull_request:
5-
push:
6-
branches:
7-
- main
4+
pull_request:
5+
push:
6+
branches:
7+
- main
88

99
concurrency:
10-
group: ${{ github.workflow }}-${{ github.ref }}
11-
cancel-in-progress: true
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
1212

1313
permissions:
14-
contents: read
14+
contents: read
1515

1616
jobs:
17-
black:
18-
runs-on: ubuntu-latest
19-
steps:
20-
- name: Checkout
21-
uses: actions/checkout@v4
22-
- name: black
23-
uses: psf/black@stable
17+
black:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
- name: black
23+
uses: psf/black@stable

‎.github/workflows/tests.yml

+57-57
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,70 @@
11
name: Tests
22

33
on:
4-
pull_request:
5-
push:
6-
branches:
7-
- main
4+
pull_request:
5+
push:
6+
branches:
7+
- main
88

99
concurrency:
10-
group: ${{ github.workflow }}-${{ github.ref }}
11-
cancel-in-progress: true
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
1212

1313
permissions:
14-
contents: read
14+
contents: read
1515

1616
env:
17-
DJANGO_SETTINGS_MODULE: tracdjangoplugin.settings_tests
18-
# passlib has a conditional import for `crypt` which is going away in python 3.13
19-
# and therefore throwing warnings
20-
PYTHONWARNINGS: >
21-
error,
22-
default:::passlib.utils,
17+
DJANGO_SETTINGS_MODULE: tracdjangoplugin.settings_tests
18+
# passlib has a conditional import for `crypt` which is going away in python 3.13
19+
# and therefore throwing warnings
20+
PYTHONWARNINGS: >
21+
error,
22+
default:::passlib.utils,
2323
2424
jobs:
25-
noshadows:
26-
runs-on: ubuntu-24.04
27-
steps:
28-
- name: Checkout
29-
uses: actions/checkout@v4
30-
- uses: actions/setup-python@v5
31-
with:
32-
python-version: '3.11'
33-
- run: pip install "tinycss2>=1.2.0"
34-
- run: python noshadows.py --tests
25+
noshadows:
26+
runs-on: ubuntu-24.04
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v4
30+
- uses: actions/setup-python@v5
31+
with:
32+
python-version: "3.11"
33+
- run: pip install "tinycss2>=1.2.0"
34+
- run: python noshadows.py --tests
3535

36-
tracdjangoplugin:
37-
runs-on: ubuntu-24.04
38-
steps:
39-
- name: Checkout
40-
uses: actions/checkout@v4
41-
- uses: actions/setup-python@v5
42-
with:
43-
python-version: '3.11'
44-
- name: Install system package dependencies
45-
run: |
46-
sudo apt-get update
47-
sudo apt-get -y install subversion
48-
- name: Install requirements
49-
run: python -m pip install -r requirements.txt
50-
- name: Run tests
51-
run: python -m django test tracdjangoplugin.tests
36+
tracdjangoplugin:
37+
runs-on: ubuntu-24.04
38+
steps:
39+
- name: Checkout
40+
uses: actions/checkout@v4
41+
- uses: actions/setup-python@v5
42+
with:
43+
python-version: "3.11"
44+
- name: Install system package dependencies
45+
run: |
46+
sudo apt-get update
47+
sudo apt-get -y install subversion
48+
- name: Install requirements
49+
run: python -m pip install -r requirements.txt
50+
- name: Run tests
51+
run: python -m django test tracdjangoplugin.tests
5252

53-
traccheck:
54-
runs-on: ubuntu-24.04
55-
steps:
56-
- name: Checkout
57-
uses: actions/checkout@v4
58-
- uses: actions/setup-python@v5
59-
with:
60-
python-version: '3.11'
61-
- name: Install system package dependencies
62-
run: |
63-
sudo apt-get update
64-
sudo apt-get -y install subversion
65-
- name: Install requirements
66-
run: python -m pip install -r requirements.txt
67-
- name: Lint Trac configuration
68-
run: python traccheck.py lint trac-env/
69-
- name: Check frozen Trac components
70-
run: python traccheck.py components --check .TRACFREEZE.txt trac-env/
53+
traccheck:
54+
runs-on: ubuntu-24.04
55+
steps:
56+
- name: Checkout
57+
uses: actions/checkout@v4
58+
- uses: actions/setup-python@v5
59+
with:
60+
python-version: "3.11"
61+
- name: Install system package dependencies
62+
run: |
63+
sudo apt-get update
64+
sudo apt-get -y install subversion
65+
- name: Install requirements
66+
run: python -m pip install -r requirements.txt
67+
- name: Lint Trac configuration
68+
run: python traccheck.py lint trac-env/
69+
- name: Check frozen Trac components
70+
run: python traccheck.py components --check .TRACFREEZE.txt trac-env/

‎.pre-commit-config.yaml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
default_language_version:
2+
python: python3
3+
4+
repos:
5+
- repo: https://github.com/pre-commit/pre-commit-hooks
6+
rev: "v5.0.0"
7+
hooks:
8+
- id: check-added-large-files
9+
args: ["--maxkb=1024"]
10+
- id: check-case-conflict
11+
- id: check-docstring-first
12+
- id: check-executables-have-shebangs
13+
- id: check-json
14+
- id: check-merge-conflict
15+
- id: check-shebang-scripts-are-executable
16+
- id: check-toml
17+
- id: check-yaml
18+
args: ["--allow-multiple-documents"]
19+
- id: debug-statements
20+
- id: detect-private-key
21+
- id: end-of-file-fixer
22+
exclude_types: [json, sql]
23+
- id: fix-byte-order-marker
24+
- id: mixed-line-ending
25+
- id: trailing-whitespace
26+
27+
- repo: https://github.com/asottile/pyupgrade
28+
rev: "v3.19.0"
29+
hooks:
30+
- id: pyupgrade
31+
args: [--py312]
32+
33+
- repo: https://github.com/adamchainz/django-upgrade
34+
rev: "1.22.2"
35+
hooks:
36+
- id: django-upgrade
37+
args: [--target-version, "5.0"]
38+
39+
- repo: https://github.com/psf/black
40+
rev: 24.10.0
41+
hooks:
42+
- id: black
43+
44+
- repo: https://github.com/rbubley/mirrors-prettier
45+
rev: "v3.4.2"
46+
hooks:
47+
- id: prettier
48+
exclude_types: [html, css, javascript, json, scss]
49+
50+
- repo: https://github.com/tox-dev/pyproject-fmt
51+
rev: "v2.5.0"
52+
hooks:
53+
- id: pyproject-fmt

‎DjangoPlugin/tracdjangoplugin/middlewares.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ def __init__(self, application):
1616
def __call__(self, environ, start_response):
1717
request_started.send(sender=self.__class__)
1818
try:
19-
for data in self.application(environ, start_response):
20-
yield data
19+
yield from self.application(environ, start_response)
2120
finally:
2221
request_finished.send(sender=self.__class__)

‎DjangoPlugin/tracdjangoplugin/plugins.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,7 @@ def _format_changeset_link(self, formatter, ns, chgset, label, fullmatch=None):
9696
return tag.a(label, class_="changeset", href=href)
9797

9898
# Fallback to the default implementation.
99-
return super(GitHubBrowserWithSVNChangesets, self)._format_changeset_link(
100-
formatter, ns, chgset, label, fullmatch
101-
)
99+
return super()._format_changeset_link(formatter, ns, chgset, label, fullmatch)
102100

103101

104102
class PlainLoginComponent(Component):

0 commit comments

Comments
 (0)