chore: regenerate addon READMEs to match CI generator output#229
Conversation
The pre-commit workflow on 19.0 fails at the oca-gen-addon-readme hook because six modules' committed README.rst / static/description/index.html no longer match the generator's output — a docutils text-wrapping skew in the rendered HTML tables. Sync them to the generator's output so the hook produces no changes. Affected: spp_api_v2_gis, spp_change_request_v2, spp_drims_sl, spp_gis_indicators, spp_hazard, spp_security.
There was a problem hiding this comment.
Code Review
This pull request consists entirely of minor formatting and layout adjustments to tables within various documentation files (README.rst) and their corresponding HTML descriptions (index.html) across multiple modules. These changes improve the alignment and readability of the documentation tables. There are no code changes or review comments, and I have no additional feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 19.0 #229 +/- ##
=======================================
Coverage 73.06% 73.06%
=======================================
Files 1069 1069
Lines 62120 62120
=======================================
Hits 45390 45390
Misses 16730 16730
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Why is this change needed?
The
pre-commitworkflow on19.0is red. The only failing hook isoca-gen-addon-readme("Generate addons README files from fragments → fileswere modified by this hook"): six modules' committed
README.rst/static/description/index.htmlno longer match the generator's output. Thedifferences are pure docutils text-wrapping skew in the rendered HTML
tables (e.g.
Water Contamination, Code:wrapping at a different column), notcontent changes. Every other hook passes.
How was the change implemented?
Synced the affected files to the generator's output so the hook produces no
changes. Because regenerating locally yields a different wrap than GitHub's
runner (a docutils version skew), the bytes here are taken from the failing
run's own
oca-gen-addon-readmediff — i.e. exactly what CI expects.Affected modules (12 files):
spp_api_v2_gis,spp_change_request_v2,spp_drims_sl,spp_gis_indicators,spp_hazard,spp_security.New unit tests
None — generated documentation files only.
Unit tests executed by the author
Triggered the
pre-commitworkflow on this branch (workflow_dispatch):oca-gen-addon-readmenow reports Passed and the whole run is green.How to test manually
Re-run the
pre-commitworkflow (orpre-commit run --all-files) — theoca-gen-addon-readmehook makes no further changes.Related links