Repository navigation
docs(readme): make every claim true and current - #3
Merged
Merged
Conversation
Co-Authored-By: Claude Code <noreply@anthropic.com>
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.
Why
An audit of
README.mdagainstorigin/mainfound a wrong tool count, a false environmentvariable claim, missing request/response contract detail and missing template sections. This PR
changes only
README.md— no code, workflow or config file is touched.Corrections, each with its proof
"9 quality/linting tools" was wrong — it is 8.
parse_tool_outputdispatches exactlyruff, ty, bandit, eslint, ruff-format, prettier, vulture and radon.
Proof:
src/result_processor.py:45-58. Both mentions now say 8 and name them.The Configuration table claimed
PORTis the HTTP listen port. The application reads noenvironment variables at all —
src/contains noos.getenv/os.environcall. The port isfixed by the uvicorn command line:
--port 8087in the DockerfileCMD, anduvicorn.run(port=8087)atsrc/test_service.py:334-341.PORTandTEST_MODEare set bythe image/compose file but are not read; the table now says so.
Documented the undocumented
X-Tenant-Idrequirement./and/healthare exempt;/execute,/docs,/redocand/openapi.jsonreturn 401 without the header(
require_tenant_header,_TENANT_EXEMPT_PATHS,src/test_service.py:36-48). This alsomade the old example curl fail; it now sends the header. The Security section states it is
an access marker, not authentication or tenancy.
POST /executedocumentation made current. The request model has atest_codefieldthat switches execution to pytest, and the response carries
tests_run,tests_passed,tests_failedandno_tests_run, with error categoriessyntax_error,timeout,no_tests_collected,tests_failed,execution_failedandinternal_error.Proof:
src/test_service.py:64-110(models) and:148-330(handler). Both executionmodes and the temp-file names are documented.
Removed the false
uv buildclaim from CI/CD. Neither the repo workflow nor the sharedarchetype runs it. Proof:
.github/workflows/ci.ymlandnonagenticai/ci-workflows/.github/workflows/python-service.yml. The section now lists theactual steps: secret/private-ref scans,
uv lock --check, ruff check + format, ty, thepytest unit suite, bandit, pip-audit, image build +
/healthsmoke, and thesha-<commit>/latestpublish with provenance frommain.Kept the claims that are true and now cite them: Python 3.14 (
python:3.14-slim,requires-python = ">=3.14"),uv0.13.7, ruff 0.17.3 / ty 0.0.92 / bandit 1.9.4 asisolated
uv toolinstalls (Dockerfile), the read-only Docker socket mount(
docker-compose.yml), and the unused redis dependency (noredisimport insrc/).Added the missing standard sections: CI and licence badges, Quick start, Security,
Contributing, and
## Licensing/## License. The Release badge is deliberately omitted:gh release list -R nonagenticai/python-test-executorreturns no releases, so the badgewould only point at an empty page.
Licensing: the code is Apache-2.0 and needs no licence key. This service performs no
licence enforcement: it reads no licence environment variable and never calls a licence
server (
git grep -i licen origin/mainfinds only theLICENSEfile and transitivelicense-expressionlock entries). The estate's optional gate is external — Envoyext_authz→license-authz, selected by theLICENSE_GATED_APP_KEYhost table; thedefault is no gate for an unlisted host and this service is not listed.
Verification
git show --staton this branch:README.mdonly (1 file changed).git diff --checkclean.🤖 Generated with Claude Code