Repository navigation
Refresh the template into a complete development standard - #279
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Owner
Author
|
Note: CodeQL default setup was enabled on this repository, which rejects results from the committed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes the template into a complete development standard: static analysis, vulnerability/secret scanning, hardened containers, and CI/CD with signed releases — on current but mature tooling. The application remains a minimal Typer CLI skeleton.
Issues found in review and fixed
container-release.yamlbadge,#adopting-the-templateanchor); uv version stated three different ways[tool.uv] required-version)v1.0.0-rc1stripped the suffix and overwrote1.0.0andlatest; logic duplicated across two workflowsrelease.yamlusingtype=pep440tags (pre-releases never movelatest)uv export --no-hashes+ pip (no hash verification); base/tool images not digest-pinneduv sync --lockedmulti-stage build, digest-pinned images, allowlist.dockerignore, Debian security upgrades, no pip at runtimepython,actions), OpenSSF Scorecard; weeklysecurity.yamluv run --locked; actionlint viaactionlint-pyinuv.lockhighonly, hiding medium findings (Dependabot cooldown)--min-severity low; Dependabot groups, 7-day cooldown, devcontainers ecosystem__main__.pyran on import and was untested; tests read the developer's.env/PROJECT_*runpy; autouse isolation fixture; coverage 96% → 100%template_python/logging.pyshadowed the stdlib name; deprecated license classifier (PEP 639 warning)log.py; classifier removedAdditions
--version/-V(works even with invalid settings),config(effective settings as JSON,SecretStrmasked),PROJECT_LOG_FORMAT=text|json; pretty exceptions no longer show locals..python-version), supported/tested 3.12–3.15, plus alowest-directdependency job (make test-lowest).S; pytest strict mode with warnings as errors; stricter mypy.v+pyproject.tomlversion; pre-push Trivy scan; multi-arch image with SBOM,mode=maxprovenance, and GitHub artifact attestation. Docker Hub publishing removed (GHCR only)..editorconfig,.gitattributes.mkdocs build --strict; new sections for technology choices, security & supply chain, and template adoption. Notes Material for MkDocs EOL (2027-05-05) and Zensical as the migration path.Breaking changes
template_python.logging→template_python.log.pyproject.toml(currently0.0.13; latest tag isv0.0.14) because the tag/version check now enforces equality.Verification
All run locally on macOS (uv 0.13.1, Docker 29.2.1):
make ci-test— format, mypy strict, Ruff, actionlint, zizmor (offline and online, 0 findings), 26 tests at 100% coverage, wheel/sdist + installed CLI/module/--versionsmoke testsmake test-lowest(pydantic 2.12, pydantic-settings 2.15, typer 0.27)make hooks-check— all 16 hooks passmake ci-test-security— pip-audit: no known vulnerabilities; gitleaks: 215 commits, no leaks; Trivy fs: cleanmake ci-test-docker— hadolint, build, Trivy image scan (HIGH/CRITICAL clean), run;docker compose upwith read-only FS and dropped capabilities; JSON logs confirmedmake ci-test-docs— strict build, no anchor warningsNot verifiable locally: CodeQL, Scorecard, and the release workflow (validated statically with actionlint/zizmor). After merge, enable code scanning, private vulnerability reporting, and branch protection as described in the adoption checklist.