Repository navigation
chore: pin TechEngine ff4e11e and document the real repository layout - #394
Merged
Merged
Conversation
This brings in GetTechAPI/TechEngine#134, the engine's own cleanup. The engine no longer carries TechAPI as a submodule, so the two repos stop pointing at each other. app/dump_check.py, app/verify/baseline.py and passmark_ids.json are gone; nothing here called them. integrity_check.py now reads the directory app.data_root resolves when no path is given, instead of a Windows path that existed on one machine. collect.yml's three `uses:` move to the same commit. In the reusable workflows only a comment changed; the collectors, the validator and the dump code are untouched.
Since the pin moved to ff4e11e, TechEngine carries no submodule, so a recursive checkout has nothing to loop on. The comments in pages.yml, pr-checks.yml, final-check.yml and build-api.sh, and two notes in the README, still warned about it. The checkouts stay plain and non-recursive; only the wording changes.
The Layout section listed five of the thirteen categories. It now has a table with each category's real path pattern, file count and an example, notes on the year, country, base-model and prefix folders, and what data/_verify/ is. A short repository map names data/, app/, site/, TechEngine/ and each workflow and script under .github/, and a new section points at the related repositories.
brand/ has a country folder, and soc/ and smartphone/ have a year folder; the file showed none of them and left out eight categories. It now lists every category, explains _verify/, and points at the table in the root README. The note about curation no longer says every record is hand-verified: `verified` on the record says that.
- data_addition offered four categories; it and data_correction now offer all thirteen. data_correction asks for the category because a slug is unique only within one. - bug_report asked for a request_id and showed api.techapi.dev. There is no live server: the example is now a static API URL and the field is gone. - feature_request no longer cites a decision record and an app that nothing in this repo explains. - The PR checklist drops a review step that is not used, and CODEOWNERS drops a finished TODO. - config.yml sends engine and game issues to their own repositories. Blank issues stay enabled.
Games moved to the game-catalog repository and data/game no longer exists, so GAME_REQUIRED and the loop over an always-empty list checked nothing. The engine's validator has no game branch either. The docstring named a validate-data.yml workflow this repo does not have; it now names what runs the validator and says which document the section numbers in the messages belong to. A comment cited a decision record that is about something else. No check changes: the full scan passes as before. Line endings are untouched (still CRLF).
.editorconfig is the same as TechEngine's: UTF-8, LF, final newline, 4 spaces for Python and 2 for YAML, JSON, Astro, Markdown and mjs. .gitattributes sets `* text=auto eol=lf`, so a Windows checkout no longer turns files into CRLF. app/validate.py was the only tracked text file stored with CRLF (all of data/ is LF already). It is renormalised here: every line shows as changed, but `git diff --ignore-cr-at-eol` against the parent is empty.
The directory it named is local to one machine and is kept out through the clone's own exclude file instead.
TechEngineBot
added
documentation
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
Closes #297
The TechEngine pin moves to ff4e11e (TechEngine 134), where the engine no longer carries TechAPI as a submodule. The loop between the two repos is gone, so the comments and README notes that warned about recursive checkouts are corrected. The README now documents all thirteen data categories with their real path patterns and counts, a repository map and the related repositories, and
data/README.mdmatches it.Changes
TechEnginegitlink and the threeuses:lines incollect.ymlmove toff4e11ec294e2f7c428bcfc3a3298ce8163e7d6a.data/and a related-repositories section.data/README.mdhad three wrong path patterns (brand, soc, smartphone).bug_report.ymlno longer asks for a request id;feature_request.ymlstands on its own; the CODEOWNERS TODO is gone.app/validate.py. Games live in game-catalog anddata/gamedoes not exist..editorconfigand.gitattributes(* text=auto eol=lf) are added.app/validate.pywas the only CRLF file in the repo and is now stored with LF; apart from line endings and the game checks its content is unchanged.No file under
data/changes exceptdata/README.md.Source
Not a data change.
Checklist
develop(mainonly moves through release PRs)python -m app.validatepasses locally