Skip to content

Commit 63221dc

Browse files
committed
lint
1 parent fd2d790 commit 63221dc

18 files changed

+236
-179
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ If applicable, add screenshots to help explain your problem.
9494
## Additional Context
9595

9696
Add any other context about the problem here:
97+
9798
- Did this work in a previous version?
9899
- Are you using any custom configuration?
99100
- Are you behind a proxy or using special networking setup?
@@ -108,4 +109,4 @@ If you have an idea of what might be causing the issue or how to fix it, please
108109
- [ ] I have checked existing issues to ensure this is not a duplicate
109110
- [ ] I have tested with the latest version
110111
- [ ] I have included all relevant information above
111-
- [ ] I have removed any sensitive information from logs and configuration
112+
- [ ] I have removed any sensitive information from logs and configuration

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ A clear and concise description of the feature you'd like to see.
1313
## Problem Statement
1414

1515
Describe the problem this feature would solve. For example:
16+
1617
- What is the current limitation?
1718
- What workflow is difficult or impossible right now?
1819
- What use case is not currently supported?
@@ -87,4 +88,4 @@ Add any other context, screenshots, or examples about the feature request here.
8788
8889
**Complexity**: [Low / Medium / High] (your estimate)
8990
90-
**Would you be willing to contribute a PR for this feature?**: [Yes / No / Maybe]
91+
**Would you be willing to contribute a PR for this feature?**: [Yes / No / Maybe]

.github/pull_request_template.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Related to #(issue)
2727

2828
<!-- List the specific changes made in this PR -->
2929

30-
-
31-
-
32-
-
30+
-
31+
-
32+
-
3333

3434
## How Has This Been Tested?
3535

@@ -45,9 +45,9 @@ Related to #(issue)
4545

4646
### Test Configuration
4747

48-
- **Docker Version**:
49-
- **Docker Compose Version**:
50-
- **OS**:
48+
- **Docker Version**:
49+
- **Docker Compose Version**:
50+
- **OS**:
5151

5252
## Screenshots (if applicable)
5353

@@ -130,4 +130,4 @@ Related to #(issue)
130130
**By submitting this pull request, I confirm that:**
131131

132132
- [ ] My contribution is made under the project's license
133-
- [ ] I have read and agree to the [contributing guidelines](CONTRIBUTING.md)
133+
- [ ] I have read and agree to the [contributing guidelines](CONTRIBUTING.md)

.github/workflows/ci.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,16 @@ jobs:
7272
run: |
7373
docker build --build-arg FIDUSWRITER_VERSION=${{ matrix.version }} -t fiduswriter-test:${{ matrix.version }} .
7474
docker run -d --name fiduswriter-test -p 8000:8000 fiduswriter-test:${{ matrix.version }}
75-
75+
7676
# Wait for container to start
7777
sleep 10
78-
78+
7979
# Check if container is running
8080
docker ps | grep fiduswriter-test
81-
81+
8282
# Check logs for errors
8383
docker logs fiduswriter-test
84-
84+
8585
# Cleanup
8686
docker stop fiduswriter-test
8787
docker rm fiduswriter-test
@@ -112,4 +112,4 @@ jobs:
112112
with:
113113
args: '**/*.md'
114114
config: '.markdownlint.json'
115-
ignore: 'node_modules'
115+
ignore: 'node_modules'

.github/workflows/docker-build.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
LATEST_VERSION="${{ steps.get-version.outputs.version }}"
7070
echo "Current version in Dockerfile: $CURRENT_VERSION"
7171
echo "Latest version on PyPI: $LATEST_VERSION"
72-
72+
7373
if [ "$CURRENT_VERSION" != "$LATEST_VERSION" ] || [ "${{ github.event_name }}" = "workflow_dispatch" ] || [ "${{ github.event_name }}" = "push" ]; then
7474
echo "should_build=true" >> $GITHUB_OUTPUT
7575
echo "Build should proceed"
@@ -121,7 +121,7 @@ jobs:
121121
fi
122122
echo "version=$VERSION" >> $GITHUB_OUTPUT
123123
echo "Building version: $VERSION"
124-
124+
125125
# Extract version components
126126
IFS='.' read -r MAJOR MINOR PATCH <<< "$VERSION"
127127
echo "major=$MAJOR" >> $GITHUB_OUTPUT
@@ -133,7 +133,7 @@ jobs:
133133
run: |
134134
VERSION="${{ steps.version.outputs.version }}"
135135
sed -i "s/ARG FIDUSWRITER_VERSION=.*/ARG FIDUSWRITER_VERSION=$VERSION/" Dockerfile
136-
136+
137137
if git diff --quiet Dockerfile; then
138138
echo "No changes to Dockerfile"
139139
else
@@ -191,23 +191,23 @@ jobs:
191191
name: Fiduswriter ${{ steps.version.outputs.version }}
192192
body: |
193193
## Fiduswriter Docker Image v${{ steps.version.outputs.version }}
194-
194+
195195
This release contains the Docker image for Fiduswriter version ${{ steps.version.outputs.version }}.
196-
196+
197197
### Docker Images
198-
198+
199199
```bash
200200
docker pull fiduswriter/fiduswriter:${{ steps.version.outputs.version }}
201201
docker pull fiduswriter/fiduswriter:${{ steps.version.outputs.major }}.${{ steps.version.outputs.minor }}
202202
docker pull fiduswriter/fiduswriter:${{ steps.version.outputs.major }}
203203
docker pull fiduswriter/fiduswriter:latest
204204
```
205-
205+
206206
### What's Changed
207207
- Updated Fiduswriter to version ${{ steps.version.outputs.version }}
208208
- Built with Python 3.14.2
209209
- Multi-architecture support (amd64, arm64)
210-
210+
211211
See [Fiduswriter Changelog](https://github.com/fiduswriter/fiduswriter/releases) for application changes.
212212
draft: false
213213
prerelease: false
@@ -232,7 +232,7 @@ jobs:
232232
run: |
233233
# Start container
234234
docker run -d --name fiduswriter-test -p 8000:8000 fiduswriter-test
235-
235+
236236
# Wait for startup (increased timeout)
237237
echo "Waiting for Fiduswriter to start..."
238238
for i in {1..30}; do
@@ -243,26 +243,26 @@ jobs:
243243
echo "Waiting... ($i/30)"
244244
sleep 2
245245
done
246-
246+
247247
# Show logs
248248
echo "Container logs:"
249249
docker logs fiduswriter-test
250-
250+
251251
# Check if container is still running
252252
if ! docker ps | grep -q fiduswriter-test; then
253253
echo "ERROR: Container stopped unexpectedly"
254254
docker logs fiduswriter-test
255255
exit 1
256256
fi
257-
257+
258258
# Verify Python version
259259
echo "Checking Python version..."
260260
docker exec fiduswriter-test python3 --version
261-
261+
262262
# Verify Fiduswriter version
263263
echo "Checking Fiduswriter version..."
264264
docker exec fiduswriter-test /fiduswriter/venv/bin/pip show fiduswriter
265-
265+
266266
# Cleanup
267267
docker stop fiduswriter-test
268-
docker rm fiduswriter-test
268+
docker rm fiduswriter-test

.github/workflows/update-version.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
run: |
6464
CURRENT="${{ steps.current-version.outputs.current }}"
6565
LATEST="${{ steps.get-version.outputs.latest }}"
66-
66+
6767
if [ "$CURRENT" != "$LATEST" ]; then
6868
echo "needs_update=true" >> $GITHUB_OUTPUT
6969
echo "New version available: $LATEST (current: $CURRENT)"
@@ -86,30 +86,30 @@ jobs:
8686
token: ${{ secrets.GITHUB_TOKEN }}
8787
commit-message: |
8888
chore: Update Fiduswriter to version ${{ steps.get-version.outputs.latest }}
89-
89+
9090
Automatically detected new Fiduswriter version on PyPI.
9191
branch: update/fiduswriter-${{ steps.get-version.outputs.latest }}
9292
delete-branch: true
9393
title: 'chore: Update Fiduswriter to version ${{ steps.get-version.outputs.latest }}'
9494
body: |
9595
## Automated Fiduswriter Version Update
96-
96+
9797
This PR updates Fiduswriter from version ${{ steps.current-version.outputs.current }} to ${{ steps.get-version.outputs.latest }}.
98-
98+
9999
### Changes
100100
- Updated `Dockerfile` to use Fiduswriter version ${{ steps.get-version.outputs.latest }}
101-
101+
102102
### Release Notes
103103
See the [Fiduswriter releases](https://github.com/fiduswriter/fiduswriter/releases) for details about what changed in this version.
104-
104+
105105
### Checklist
106106
- [ ] Review the Fiduswriter changelog
107107
- [ ] Test the Docker image builds successfully
108108
- [ ] Test the application starts correctly
109109
- [ ] Verify no breaking changes affect the Docker setup
110-
110+
111111
---
112-
112+
113113
🤖 This PR was created automatically by the version check workflow.
114114
labels: |
115115
automated
@@ -120,4 +120,4 @@ jobs:
120120
- name: Notify if update found
121121
if: steps.compare.outputs.needs_update == 'true'
122122
run: |
123-
echo "::notice::New Fiduswriter version ${{ steps.get-version.outputs.latest }} detected. PR created."
123+
echo "::notice::New Fiduswriter version ${{ steps.get-version.outputs.latest }} detected. PR created."

.hadolint.yaml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
1-
---
21
failure-threshold: error
32

43
ignored:
54
# DL3008: Pin versions in apt-get install
65
# We intentionally don't pin apt package versions as they can vary by Ubuntu release
7-
- DL3008
8-
6+
- DL3008
7+
98
# DL3009: Delete the apt-get lists after installing
109
# We handle this with rm -rf /var/lib/apt/lists/*
11-
- DL3009
12-
10+
- DL3009
11+
1312
# DL3015: Avoid additional packages by specifying --no-install-recommends
1413
# Some packages need their recommended dependencies
15-
- DL3015
16-
14+
- DL3015
15+
1716
# DL3016: Pin versions in npm
1817
# Node.js is installed from NodeSource and doesn't need explicit pinning
19-
- DL3016
20-
18+
- DL3016
19+
2120
# DL3049: Label info messages
2221
# Labels are not critical for this use case
23-
- DL3049
24-
22+
- DL3049
23+
2524
# DL3059: Multiple consecutive RUN instructions
2625
# We prefer readability over layer optimization in some cases
27-
- DL3059
28-
26+
- DL3059
27+
2928
# DL4006: Set SHELL option -o pipefail
3029
# Using default shell behavior
31-
- DL4006
30+
- DL4006
3231

3332
trustedRegistries:
34-
- docker.io
35-
- ghcr.io
33+
- docker.io
34+
- ghcr.io
3635

3736
no-fail: false
38-
no-color: false
37+
no-color: false

.markdownlint.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@
2626
"front_matter_title": ""
2727
},
2828
"MD033": {
29-
"allowed_elements": ["br", "img", "table", "thead", "tbody", "tr", "th", "td"]
29+
"allowed_elements": ["br", "img", "table", "thead", "tbody", "tr", "th", "td", "details", "summary"]
3030
},
31+
"MD036": false,
32+
"MD040": false,
3133
"MD041": false,
3234
"no-hard-tabs": true,
3335
"whitespace": true
34-
}
36+
}

0 commit comments

Comments
 (0)