Repository navigation
Conversation
TECHNICAL_REPORTS/ held 980 files (490 en/ko pairs) with no index and no inbound link, so a report could not be found or mapped to its PR. A hand-kept table would drift on the next report, so the index is generated. - scripts/ci/gen_reports_index.py writes TECHNICAL_REPORTS/README.md: one row per report stem, newest number first, with the PR link, the cleaned H1 title, the date (file-name suffix, else the header Date/Updated line) and en/ko links. --check exits 1 when the committed index is stale. - tests/test_gen_reports_index.py covers the stale cases (new report, retitled report, hand edit, missing index), unpaired and pipe-bearing titles, and asserts the committed index is current and links every report file. It runs in verify-python-tooling and CI's python-tooling job, so a report PR that skips `make reports-index` fails there. - Makefile gains reports-index and verify-reports-index; docs/README.md points at the directory. TECHNICAL_REPORTS/ is gitignored, so the README is force-added like the reports. Closes #1708
inureyes
added
type:docs
This branch has not been deployed
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.
Closes #1708
TECHNICAL_REPORTS/has grown to 980 files (490 en/ko pairs) since the issue was filed, with mixed heading and date formats. A hand-written table would go stale on the next report, so this PR generates the index and has CI enforce it.scripts/ci/gen_reports_index.pywritesTECHNICAL_REPORTS/README.md: one row per report, newest number first, with a PR link, the H1 title minus theTechnical Report: PR #N -boilerplate, the date (file-name suffix, else the headerDate/Updatedline) and en/ko links. A missing language shows as-.--checkexits 1 when the committed index is stale.tests/test_gen_reports_index.pybreaks a synthetic directory the way a report PR would (new report, retitled report, hand edit, missing index) and asserts--checkrejects each one. It also checks that the repository's committed index is current and that it links every report file on disk. The suite runs in the existingpython-toolingCI job, so a report PR that skipsmake reports-indexfails there with a message naming the fix.make reports-index/make verify-reports-index, plus a pointer section indocs/README.md.TECHNICAL_REPORTS/is gitignored, so the README is force-added the same way the reports are.Validation: all 490 reports get a title, a date and both language links.
python3 -m unittest discover -s testspasses (206 tests), and so domake verify-reports-indexand the license-header check. This PR has no Rust changes.