refactor: split out engine to TechEngine (TechAPI = data + site)#3
Merged
Conversation
49 tasks
…deploy TechAPI is now the curated dataset + public site + a lightweight bundled validator, and deploys its own GitHub Pages homepage. The API server, ingestion crawlers, static-dump generator, coverage checks and full validation live in TechEngine (linked as a submodule). - remove app/ backend, tests/, scripts/ (dump.py, seed.py), docs/, Dockerfile, docker-compose.yml, .env.example, .dockerignore, pyproject.toml - remove refresh-data.yml + test.yml (dump refresh and backend tests belong to TechEngine) - rewrite deploy-pages.yml to build & deploy site/ WITHOUT the backend — Pages is per-repo, so TechAPI deploys its own homepage; the static JSON dump it serves is produced by TechEngine and committed under site/public/v1 - keep data/, site/, the lightweight validator (scripts/validate.py -> app/validate.py) and validate-data.yml (self-check, then chains to TechEngine's full validation) Refs #1
26cc866 to
de5cb0c
Compare
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.
What & why
Makes TechAPI and TechEngine non-overlapping. TechAPI = the curated dataset + public site + a lightweight bundled validator, and it deploys its own GitHub Pages homepage (Pages is per-repo). The API server, ingestion crawlers, static-dump generator, coverage checks and full validation live in TechEngine (linked here as a submodule).
Removed (now owned by TechEngine):
app/backend (config, database, main, models, routers, schemas, services),tests/,scripts/(dump.py, seed.py),docs/(API design),Dockerfile,docker-compose.yml,.env.example,.dockerignore,pyproject.toml.github/workflows/:refresh-data.yml(dump refresh) +test.yml(backend tests)Kept / changed:
data/,site/, lightweight validator (scripts/validate.py→app/validate.py)validate-data.yml— self-checks, then chains to TechEngine's fullvalidate-data(reusable) workflowdeploy-pages.ymlrewritten to build & deploysite/without the backend — TechAPI owns/deploys its homepage; the static JSON dump it serves is produced by TechEngine and committed undersite/public/v1Dump delivery (the one remaining wire-up)
TechAPI no longer generates the dump (that needs the engine). For live data on the site, TechEngine must commit/refresh the dump into
site/public/v1(andopenapi.json) here — thendeploy-pagespublishes it. Until that's wired, the site deploys and renders with its graceful fallbacks (no live data).Refs #1
Checklist
python -m app.validatepasses locally (bundled validator kept)deploy-pagesno longer depends on the removed backend