1. Mailing Lists
  2. Contributors
  3. Re: README generator update

Contributors mailing list archives

contributors@odoo-community.org

Browse archives

Please, review my PR

Re: README generator update

Avatar

Re: README generator update

by
Acsone SA/NV, Denis Roussel
- 03/09/2023 14:48:05
Great! Thanks 

Le 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
http://acsone.eu/

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe

Reference