Skip to content

add reference sync check - #204

Merged
vagenas merged 4 commits into
mainfrom
reference-sync-check
Oct 30, 2026
Merged

vagenas merged 4 commits into
mainfrom
reference-sync-check

Conversation

@vagenas

@vagenas vagenas commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Annex A of spec.md is generated from reference/input/reference.xlsx, but nothing checks the two agree. A hand edit to Annex A goes unnoticed, and the next prepare_release.py run quietly overwrites it.

  • generate_reference.py --check rebuilds Annex A in memory and fails if spec.md differs, without writing anything.
  • The new pre-commit hook reference-sync-check runs it when spec.md, reference/input/ or the script change.
  • CONTRIBUTING notes that Annex A must not be edited by hand.
  • So that CI can run the hook, docling (dev group, pulls in torch) is replaced by docling-slim[format-xlsx] in the ci group. It requires 2.144.0 or later, since 2.143.x imports torch in DocumentConverter.

Signed-off-by: Panos Vagenas <pva@zurich.ibm.com>
Signed-off-by: Panos Vagenas <pva@zurich.ibm.com>
Signed-off-by: Panos Vagenas <pva@zurich.ibm.com>
@vagenas
vagenas added this pull request to stack #206 October 28, 2026 10:45
Signed-off-by: Panos Vagenas <pva@zurich.ibm.com>
@vagenas
vagenas removed this pull request from stack #206 October 29, 2026 10:26
@vagenas
vagenas added this pull request to stack #208 October 29, 2026 10:29
@vagenas
vagenas marked this pull request as draft October 29, 2026 10:35
@vagenas
vagenas removed this pull request from stack #208 October 29, 2026 12:53
@vagenas
vagenas marked this pull request as ready for review October 29, 2026 13:22
@vagenas
vagenas added this pull request to stack #217 October 29, 2026 16:38

@lehors lehors left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I tested it and it works for me. :-)

@vagenas
vagenas merged commit da4f4bf into main Oct 30, 2026
10 checks passed
@vagenas
vagenas deleted the reference-sync-check branch October 30, 2026 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants