Skip to content

Commit fda9487

Browse files
committed
chore: update .gitignore and README for improved documentation and environment setup
- Added test_output.txt to .gitignore for better file management. - Updated README to include Windows-specific commands for running tests and building the project. - Clarified CI workflow details, including lint checks and vulnerability audits.
1 parent c6bed25 commit fda9487

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ results/
1212
.secnode_temp/
1313
.api-agent/
1414
all_tests.txt
15+
test_output.txt
1516

1617
# Python cache and build
1718
__pycache__/
@@ -29,10 +30,11 @@ build/
2930
# macOS
3031
.DS_Store
3132

32-
# IDEs
33+
# IDEs and editor config
3334
.idea/
3435
.vscode/
3536
.cursor/
37+
.cursorrules
3638

3739
# Logs
3840
*.log

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,13 +205,25 @@ make test-cov-uv
205205
make build-uv
206206
```
207207

208+
On Windows, if `make` is unavailable, use `uv run` directly:
209+
210+
```powershell
211+
uv sync --extra dev
212+
uv run ruff check src tests
213+
uv run pytest
214+
uv run pytest --cov=src/secnodeapi --cov-report=term-missing
215+
uv build
216+
```
217+
208218
## CI
209219

210220
GitHub Actions workflow runs:
211221

212-
- lint checks
213-
- test suite with coverage thresholds
222+
- lint checks (ruff)
223+
- test suite with coverage thresholds (pytest)
214224
- package build
225+
- dependency vulnerability audit (pip-audit)
226+
- container vulnerability scan (Trivy)
215227
- scan job template for staging targets
216228

217229
## Direct Microservices Runtime

0 commit comments

Comments
 (0)