Skip to content

Commit

Permalink
feat: generate private addon readmes with markdown fragments
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
yajo committed Oct 10, 2023
1 parent 19b5ecb commit 6c5462b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
16 changes: 10 additions & 6 deletions .module-readme.rst.j2
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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') }}
Expand All @@ -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 }}.

Expand Down
5 changes: 1 addition & 4 deletions .pre-commit-config.yaml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6c5462b

Please sign in to comment.