Skip to content

chore: regenerate addon READMEs to match CI generator output#229

Merged
emjay0921 merged 1 commit into
19.0from
fix/ci-readme-generator-skew
Jun 8, 2026
Merged

chore: regenerate addon READMEs to match CI generator output#229
emjay0921 merged 1 commit into
19.0from
fix/ci-readme-generator-skew

Conversation

@emjay0921

Copy link
Copy Markdown
Contributor

Why is this change needed?

The pre-commit workflow on 19.0 is red. The only failing hook is
oca-gen-addon-readme ("Generate addons README files from fragments → files
were modified by this hook"): six modules' committed README.rst /
static/description/index.html no longer match the generator's output. The
differences are pure docutils text-wrapping skew in the rendered HTML
tables (e.g. Water Contamination, Code: wrapping at a different column), not
content 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-readme diff — 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-commit workflow on this branch (workflow_dispatch):
oca-gen-addon-readme now reports Passed and the whole run is green.

How to test manually

Re-run the pre-commit workflow (or pre-commit run --all-files) — the
oca-gen-addon-readme hook makes no further changes.

Related links

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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.06%. Comparing base (e9dad7e) to head (e07946a).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             19.0     #229   +/-   ##
=======================================
  Coverage   73.06%   73.06%           
=======================================
  Files        1069     1069           
  Lines       62120    62120           
=======================================
  Hits        45390    45390           
  Misses      16730    16730           
Flag Coverage Δ
fastapi 86.92% <ø> (ø)
spp_alerts 96.77% <ø> (ø)
spp_analytics 93.13% <ø> (ø)
spp_api_v2 80.33% <ø> (ø)
spp_api_v2_change_request 66.85% <ø> (ø)
spp_api_v2_cycles 71.12% <ø> (ø)
spp_api_v2_data 64.41% <ø> (ø)
spp_api_v2_entitlements 70.19% <ø> (ø)
spp_api_v2_gis 71.52% <ø> (ø)
spp_api_v2_products 66.27% <ø> (ø)
spp_api_v2_service_points 70.94% <ø> (ø)
spp_api_v2_simulation 71.12% <ø> (ø)
spp_base_common 90.26% <ø> (ø)
spp_change_request_v2 75.46% <ø> (ø)
spp_drims_sl 0.00% <ø> (ø)
spp_gis_indicators 91.07% <ø> (ø)
spp_hazard 99.59% <ø> (ø)
spp_programs 64.84% <ø> (ø)
spp_registry 86.83% <ø> (ø)
spp_security 66.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@emjay0921
emjay0921 merged commit 74516d3 into 19.0 Jun 8, 2026
36 checks passed
@emjay0921
emjay0921 deleted the fix/ci-readme-generator-skew branch June 8, 2026 11:39
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.

2 participants