Contributors mailing list archives
contributors@odoo-community.org
Browse archives
README generator update
by
Acsone SA/NV, Stéphane Bidoul
Hi everyone,
Today I deployed a new version of the README.rst generator in the OCA GitHub bot.
It includes several important improvements:
- Support for a CONTEXT fragment to document the use case and/or when to use the addon. 🙏
- Support for markdown fragments (more on that soon). ✨
- "Try me" links to runboat instead of runbot.
- Various minor other improvements contributed over the last 3-4 years.
The reason it was not deployed sooner is that every tiny change in the generated README.rst did cause a full CI run and publication to PyPI for all our 10k+ addons across branches. Now the generated document contains a digest of the source content and it is re-generated only when the fragments or manifests change and not when the generator changes.
A full rebuild is in progress right now. Please be patient until the CI queue processes everything.
Best regards,
-sbi
--
Stéphane Bidoul
Follow-Ups
-
-
-
-
Re: README generator update
byDIXMIT Consulting SLU, Enric Tobella Alomar- 03/09/2023 14:09:11 - 0
