56 lines
2.0 KiB
Markdown
56 lines
2.0 KiB
Markdown
# 07 - Development
|
|
|
|
## Common commands
|
|
|
|
```bash
|
|
go run ./cmd/qfs
|
|
make migrate-status # server SQL migrations: applied/pending
|
|
make migrate # apply pending server SQL migrations
|
|
go run ./cmd/migrate_project_updated_at
|
|
go test ./...
|
|
go vet ./...
|
|
make security-check # pinned govulncheck, blocks reachable vulnerabilities
|
|
# Optional live transport checks; owns disposable Docker containers:
|
|
go test -tags integration ./internal/mariadb -run TestMariaDBTLSIntegration -count=1
|
|
make build-release
|
|
make install-hooks
|
|
```
|
|
|
|
## Guardrails
|
|
|
|
- run `gofmt` before commit;
|
|
- use `slog` for server logging;
|
|
- keep runtime business logic SQLite-only;
|
|
- limit MariaDB access to sync, setup, and migration tooling;
|
|
- keep `config.yaml` out of git and use `config.example.yaml` only as a template;
|
|
- update `bible-local/` in the same commit as architecture changes.
|
|
|
|
## Removed features that must not return
|
|
|
|
- admin pricing UI/API;
|
|
- alerts and notification workflows;
|
|
- stock import tooling;
|
|
- cron jobs;
|
|
- standalone importer utility.
|
|
|
|
## Release notes
|
|
|
|
Release history belongs under `releases/<version>/RELEASE_NOTES.md`.
|
|
Do not keep temporary change summaries in the repository root.
|
|
|
|
## Toolchain and release security
|
|
|
|
`go.mod` requires Go 1.27.3 or newer, including security fixes in the standard
|
|
library. This minimum also rejects older compilers with `GOTOOLCHAIN=local`;
|
|
normal Go toolchain selection downloads a suitable compiler when necessary.
|
|
`make security-check` runs `golang.org/x/vuln/cmd/govulncheck@v1.9.0 ./...`.
|
|
The scanner version is pinned in the Makefile. All release build targets and
|
|
`scripts/release.sh` require this check to succeed before producing artifacts.
|
|
A scanner/database/download failure also stops release.
|
|
`node scripts/tests/release-security.cjs` verifies failure stops all release
|
|
entry points before artifact creation using an isolated failing scanner.
|
|
|
|
When updating dependencies: run `go mod tidy`, `go test ./...`, `go vet ./...`,
|
|
`make security-check` and the JavaScript regression check documented in
|
|
[02-architecture.md](02-architecture.md).
|