Open
Conversation
Remove .rst readme fragments that have .md duplicates (the hook cannot process both) and regenerate all auto-generated README.rst and index.html files to match the current oca-gen-addon-readme output.
Summary of ChangesHello @emjay0921, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on documentation maintenance and build process stability. It addresses issues with outdated and conflicting README files by removing duplicate formats and regenerating all documentation files. This ensures that the project's documentation is accurate and that automated checks pass successfully, streamlining future development workflows. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 19.0 #57 +/- ##
==========================================
- Coverage 72.02% 68.74% -3.29%
==========================================
Files 65 398 +333
Lines 6148 31554 +25406
==========================================
+ Hits 4428 21691 +17263
- Misses 1720 9863 +8143
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request regenerates README files to fix a pre-commit hook failure. While this resolves the hook issue, the regeneration process has introduced several formatting problems in the tables within the README.rst files. Many tables now have reduced column widths, causing long identifiers and code blocks to wrap across multiple lines, sometimes breaking the reStructuredText syntax. This significantly degrades the readability of the documentation. I've added specific comments on a few representative files to illustrate the different types of issues. It's recommended to investigate the configuration of the oca-gen-addon-readme tool to prevent these formatting issues in the future, as this affects many modules.
Comment on lines
+118
to
+119
| | ``spp_ | Read approval records | | ||
| | approval.group_approval_viewer`` | | |
There was a problem hiding this comment.
The automatic regeneration of this table has reduced the column width, causing the group names to wrap. This harms readability. For example, spp_approval.group_approval_viewer is now split across two lines. It would be better to adjust the table formatting to keep these identifiers on a single line, as they were previously. This issue is present in multiple README files across this PR.
Comment on lines
+109
to
+110
| | ` | Full CRUD on audit rules and | | ||
| | `spp_audit.group_audit_manager`` | logs | |
There was a problem hiding this comment.
The table regeneration has introduced a formatting issue. The group name spp_audit.group_audit_manager is now split, and there's a stray backtick on a new line. This breaks the inline code formatting and makes the README harder to read and potentially render incorrectly. This type of formatting error appears in several other README files in this PR.
Comment on lines
+476
to
+477
| <tr><td>` | ||
| <cite>spp_audit.group_audit_manager`</cite></td> |
There was a problem hiding this comment.
The generated HTML for this table cell is broken. It contains <cite> tags and backticks instead of the expected <tt> tag for code. This is likely a result of the formatting issue in the source README.rst file. Fixing the source should resolve this rendering problem. Similar HTML rendering issues are present in other generated index.html files.
Comment on lines
+77
to
+78
| | ` | Detail model for editing | | ||
| | `spp.cr.detail.edit_individual`` | individual registrant data | |
There was a problem hiding this comment.
The table regeneration has introduced a formatting issue. The model name spp.cr.detail.edit_individual is now split, and there's a stray backtick on a new line. This breaks the inline code formatting. The same issue occurs for other models in this table (e.g., spp.cr.detail.exit_registrant). This should be fixed in the generation tool.
Comment on lines
+59
to
+147
| +----------------------------------+----------------------------------+ | ||
| | Model | Description | | ||
| +==================================+==================================+ | ||
| | ``spp.program`` | Main program with managers, | | ||
| | | target type, and funding | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.cycle`` | Time-bound distribution cycle | | ||
| | | within a program | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.program.membership`` | Enrolls registrant in program | | ||
| | | with state tracking | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.cycle.membership`` | Links registrant to specific | | ||
| | | cycle for entitlement prep | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.entitlement`` | Cash entitlement with approval | | ||
| | | workflow | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.entitlement.inkind`` | In-kind entitlement with | | ||
| | | product, quantity, warehouse | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.payment`` | Individual payment linked to | | ||
| | | cash entitlement | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.payment.batch`` | Groups payments for batch | | ||
| | | processing and reconciliation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.payment.batch.tag`` | Tags for categorizing payment | | ||
| | | batches | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.eligibility.manager`` | Wrapper for eligibility manager | | ||
| | | implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | `` | Base eligibility manager | | ||
| | spp.program.membership.manager`` | (abstract) | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.prog | Default eligibility | | ||
| | ram.membership.manager.default`` | implementation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.deduplication.manager`` | Wrapper for deduplication | | ||
| | | manager implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``sp | Notification manager for | | ||
| | p.program.notification.manager`` | beneficiary communications | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.program.manager`` | Wrapper for program lifecycle | | ||
| | | manager implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.program.manager.default`` | Default program manager | | ||
| | | implementation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.cycle.manager`` | Wrapper for cycle manager | | ||
| | | implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.cycle.manager.default`` | Default cycle manager | | ||
| | | implementation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``s | Wrapper for entitlement manager | | ||
| | pp.program.entitlement.manager`` | implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.progr | Default entitlement manager | | ||
| | am.entitlement.manager.default`` | implementation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.pr | Cash entitlement manager with | | ||
| | ogram.entitlement.manager.cash`` | amount calculation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.prog | In-kind entitlement manager with | | ||
| | ram.entitlement.manager.inkind`` | product configuration | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.program.payment.manager`` | Wrapper for payment manager | | ||
| | | implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.p | Default payment manager | | ||
| | rogram.payment.manager.default`` | implementation | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.compliance.manager`` | Wrapper for compliance manager | | ||
| | | implementations | | ||
| +----------------------------------+----------------------------------+ | ||
| | `` | Default compliance manager with | | ||
| | spp.compliance.manager.default`` | CEL support | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.program.fund`` | Tracks program budget and fund | | ||
| | | utilization | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp.program.fund.report.view`` | Fund balance reporting view | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``sp | Tracks duplicate membership | | ||
| | p.program.membership.duplicate`` | records | | ||
| +----------------------------------+----------------------------------+ |
There was a problem hiding this comment.
The model names in this table are now wrapped across multiple lines, making the table very difficult to read. This is a significant degradation in documentation quality and should be addressed by adjusting the table generation logic.
emjay0921
changed the title
- spp_grm: migrate res_config_settings view to Odoo 19 app/block/setting
structure (old xpath //div[hasclass('settings')] no longer exists)
- spp_mis_demo_v2: update test assertions for 7th program
(conditional_child_grant) added in recent merge
`manual: true` is not valid pre-commit syntax and gets silently ignored, causing oca-gen-addon-readme and oca-gen-external-dependencies to run in CI. The README hook then fails due to platform-dependent docutils table rendering differences between Ubuntu (CI) and macOS. Replace with `stages: [manual]` which is the correct pre-commit way to exclude hooks from normal runs.
The codecov/project check fails on coverage decreases with no config. Set project status to informational so it reports but doesn't block, while keeping patch coverage as the gating check.
detect_modules.py was counting README.rst, static/description/, and readme/ fragment changes as module code changes. This caused CI to test 62 modules for a docs-only PR, uploading coverage for untested modules and dropping the codecov/project percentage. Now ignores documentation-only file changes, reducing detected modules from 62 to 7 (only actual code changes + critical modules).
The res_config_settings_views.xml referenced fields (helpdesk_mgmt_portal_select_team, etc.) that were never defined in spp_grm's res.config.settings model — leftover from the helpdesk_mgmt fork. No menu pointed to its action either. Removes the dead view file and its manifest entry.
This reverts commit 94a0df2.
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
1 participant
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.
Why is this change needed?
The
19.0branch has several CI failures:Pre-commit
oca-gen-addon-readmehook fails because multiple modules have both.rstand.mdreadme fragmentsREADME.rstandindex.htmlfiles are stale after recent PR merges (feat: GIS foundations and registrant GPS coordinates #42, feat: add HXL modules and GIS indicator layers #47)manual: trueonoca-gen-addon-readmeandoca-gen-external-dependencieshooks is not valid pre-commit syntax — it gets silently ignored, causing the hooks to run in CI where platform-dependentdocutilsrendering produces different RST table formatting (Ubuntu vs macOS)Tests
spp_grm: Registry crash —res_config_settings_views.xmlreferenceshelpdesk_mgmt_portal_*fields that were never defined (leftover from helpdesk_mgmt fork). Removed the dead view.spp_mis_demo_v2: 3 test failures — hardcoded program count of 6 but a 7th program was added in recent mergesCodecov (open)
codecov/projectreports -3.29% coverage drop. The BASE commit (2a25b61) tested 4 modules (spp_dci_demo, spp_demo, spp_grm_demo, spp_mis_demo_v2) across 65 files. This PR's HEAD tests 7 modules across 398 files — the larger test surface includes modules with lower coverage, diluting the overall percentage. Not a blocking check (no branch protection on19.0).How was the change implemented?
.rstreadme fragments that have.mdduplicatesREADME.rstandindex.htmlfiles viaoca-gen-addon-readmemanual: truewith correctstages: [manual]foroca-gen-addon-readmeandoca-gen-external-dependencieshooksspp_grm/views/res_config_settings_views.xml(undefinedhelpdesk_mgmt_portal_*fields, no menu reference)spp_mis_demo_v2test assertions to match current program countNew unit tests
N/A
Unit tests executed by the author
spp_grm— 0 failed, 0 errors of 25 testsspp_grm_demo— 0 failed, 0 errors of 31 testsspp_mis_demo_v2— 0 failed, 0 errors of 31 testsHow to test manually
19.0after mergeRelated links
Fixes pre-commit and test CI failures on
19.0branch