From 6c5462b52ee4dc6aba6a12019a9a1d0c4964d115 Mon Sep 17 00:00:00 2001 From: Jairo Llopis Date: Tue, 10 Oct 2023 12:13:34 +0100 Subject: [PATCH] feat: generate private addon readmes with markdown fragments Adds support for the latest changes found in maintainer tools. Now, readmes will have a source digest, resulting in fewer rebuilds, and markdown portions are supported. --- .module-readme.rst.j2 | 16 ++++++++++------ .pre-commit-config.yaml.jinja | 5 +---- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.module-readme.rst.j2 b/.module-readme.rst.j2 index 808676cf..df2b84c9 100644 --- a/.module-readme.rst.j2 +++ b/.module-readme.rst.j2 @@ -11,10 +11,13 @@ {{ manifest.name }} {{ '=' * manifest.name|length }} -.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: {{ source_digest }} + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. |badge_devstat| image:: https://img.shields.io/badge/maturity-{{ development_status | replace("-", "--") | urlencode }}-brightgreen.png :target: https://odoo-community.org/page/development-status @@ -40,7 +43,8 @@ .. contents:: :local: -{{ fragment('INSTALL', 'Installation') }} +{{ fragment('CONTEXT', 'Use Cases / Context') }} +{{- fragment('INSTALL', 'Installation') }} {{- fragment('CONFIGURE', 'Configuration') }} {{- fragment('USAGE', 'Usage') }} {{- fragment('DEVELOP', 'Development') }} @@ -52,17 +56,17 @@ Credits {% if authors -%} Authors -~~~~~~~ +{{ level3_underline * 7 }} {% for author in authors if author -%} * {{ author }} {% endfor %} {% endif -%} -{{ fragment('CONTRIBUTORS', 'Contributors', sub='~') }} -{{- fragment('CREDITS', 'Other credits', sub='~') -}} +{{ fragment('CONTRIBUTORS', 'Contributors', sub=level3_underline) }} +{{- fragment('CREDITS', 'Other credits', sub=level3_underline) -}} Maintainers -~~~~~~~~~~~ +{{ level3_underline * 11 }} This module is maintained by {{ org_name }}. diff --git a/.pre-commit-config.yaml.jinja b/.pre-commit-config.yaml.jinja index a33f5019..ff6814ed 100644 --- a/.pre-commit-config.yaml.jinja +++ b/.pre-commit-config.yaml.jinja @@ -25,16 +25,13 @@ repos: language: fail files: "\\.rej$" - repo: https://github.com/oca/maintainer-tools - rev: b9c963d + rev: 1070863d1298b1bf373a0e69458dd8a88ab91578 hooks: # update the NOT INSTALLABLE ADDONS section above - id: oca-update-pre-commit-excluded-addons args: - --addons-dir - odoo/custom/src/private - - repo: https://github.com/oca/maintainer-tools - rev: 05e2174 - hooks: - id: oca-gen-addon-readme args: - --addons-dir=odoo/custom/src/private