chore: regenerate all READMEs with Python 3.11 to match CI#95
chore: regenerate all READMEs with Python 3.11 to match CI#95
Conversation
CI pre-commit uses Python 3.11. The docutils library produces slightly different HTML between Python 3.11 and 3.12 (column widths, text wrapping). This one-time regeneration aligns all auto-generated files with CI to prevent pre-commit failures on future PRs.
Summary of ChangesHello, 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 addresses a recurring issue in the continuous integration pipeline where pre-commit checks failed due to discrepancies in auto-generated documentation files. The root cause was identified as a difference in the Python version used for generating these files versus the version used in the CI environment. By regenerating all affected Highlights
Changelog
Activity
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 #95 +/- ##
==========================================
+ Coverage 70.39% 70.51% +0.11%
==========================================
Files 674 707 +33
Lines 37005 39125 +2120
==========================================
+ Hits 26051 27590 +1539
- Misses 10954 11535 +581
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request regenerates documentation files to align with the CI environment using Python 3.11. While the intent is clear and necessary for CI to pass, the regeneration process has introduced significant formatting issues in many of the README.rst files. Specifically, tables containing long lines with inline code are now incorrectly wrapped, leading to malformed reStructuredText that will not render correctly. I've added a specific comment highlighting one such instance, but the issue is widespread across the changed files. I recommend investigating and fixing the oca-gen-addon-readme tool or the custom template being used to resolve this systematic formatting problem before merging.
| | ` | Full CRUD on audit rules and | | ||
| | `spp_audit.group_audit_manager`` | logs | |
There was a problem hiding this comment.
The automatic regeneration of this file seems to have introduced a formatting issue in this table. The content of the first cell, ``spp_audit.group_audit_manager``, has been incorrectly wrapped across two lines, resulting in malformed reStructuredText with mismatched backticks. This will likely cause rendering issues.
This problem appears in many of the updated README.rst files in this pull request (e.g., in spp_approval/README.rst, spp_cel_domain/README.rst, spp_change_request_v2/README.rst, etc.). It would be best to fix the generation script to handle line wrapping within tables correctly before merging these changes, as the current state degrades the quality of the documentation.
Why is this change needed?
CI pre-commit uses Python 3.11 but these auto-generated files were committed using Python 3.12. The
docutilslibrary produces slightly different HTML between versions (column widths, text wrapping), causing every PR to fail the pre-commit check.How was the change implemented?
Ran
oca-gen-addon-readmeunder Python 3.11 with the correct custom template (tools/readme_template.rst.jinja) to regenerate allREADME.rstandstatic/description/index.htmlfiles.New unit tests
Unit tests executed by the author
How to test manually
Related links