Archives
Contributors
README generator update
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
by Stéphane Bidoul - 02:06 - 3 Sep 2023
Follow-Ups
-
Re: README generator update
El dom, 03-09-2023 a las 12:07 +0000, Stéphane Bidoul escribió:A full rebuild is in progress right now. Please be patient until the CI queue processes everything.There's still the functional issue we're having on reviews, which is fixed with https://github.com/OCA/oca-addons-repo-template/pull/190. I updated that PR to fetch the latest commit from maintainer-tools. After this mass rebuild, we should be finally able to merge it, right?Thanks for all the work involved!
by Jairo Llopis - 11:51 - 4 Sep 2023 -
-
Re: README generator update
Great! ThanksLe dim. 3 sept. 2023, 14:07, Stéphane Bidoul <notifications@odoo-community.org> a écrit :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_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe
by Denis Roussel - 02:51 - 3 Sep 2023 - Support for a CONTEXT fragment to document the use case and/or when to use the addon. 🙏
-
Re: README generator update
Thanks for the great work!!On Sun, 3 Sept 2023, 14:07 Stéphane Bidoul, <notifications@odoo-community.org> wrote: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_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe
by Enric Tobella Alomar - 02:11 - 3 Sep 2023 - Support for a CONTEXT fragment to document the use case and/or when to use the addon. 🙏
