Skip to content

Commit

Permalink
[UPD] README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@OCA-git-bot
OCA-git-bot committed Nov 8, 2022
1 parent 350c170 commit 707cef8
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 24 deletions.
52 changes: 39 additions & 13 deletions module_change_auto_install/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Change auto installable modules
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/15.0/module_change_auto_install
:target: https://github.com/OCA/server-tools/tree/16.0/module_change_auto_install
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-module_change_auto_install
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-module_change_auto_install
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/15.0
:target: https://runbot.odoo-community.org/runbot/149/16.0
:alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|
Expand Down Expand Up @@ -75,22 +75,48 @@ Configuration
server_wide_modules = web,module_change_auto_install
modules_auto_install_disabled = partner_autocomplete,iap,mail_bot,account_edi,account_edi_facturx,account_edi_ubl
modules_auto_install_disabled =
partner_autocomplete,
iap,
mail_bot
modules_auto_install_enabled = web_responsive,web_no_bubble,base_technical_features,disable_odoo_online,account_menu
modules_auto_install_enabled =
web_responsive:web,
base_technical_features,
disable_odoo_online,
account_usability
Run your instance and check logs. Modules that has been altered should be present in your log, at the load of your instance:

.. code-block:: shell
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'iap' has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'mail_bot' has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'partner_autocomplete' has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'account_edi' has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'account_edi_facturx' has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'account_edi_ubl' has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'iap' has been marked as NOT auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'mail_bot' has been marked as NOT auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module 'partner_autocomplete' has been marked as NOT auto installable.
INFO db_name odoo.modules.loading: 42 modules loaded in 0.32s, 0 queries (+0 extra)
**Advanced Configuration Possibilities**

if your ``odoo.cfg`` file contains the following configuration:

.. code-block:: shell
modules_auto_install_enabled =
account_usability,
web_responsive:web,
base_technical_features:,
point_of_sale:sale/purchase
The behaviour will be the following:

* ``account_usability`` module will be installed as soon as all the default dependencies are installed. (here ``account``)

* ``web_responsive`` module will be installed as soon as ``web`` is installed. (Althought ``web_responsive`` depends on ``web`` and ``mail``)

* ``base_technical_features`` will be ALWAYS installed

* ``point_of_sale`` module will be installed as soon as ``sale`` and ``purchase`` module are installed.

Development
===========

Expand All @@ -105,7 +131,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_change_auto_install%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_change_auto_install%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Expand Down Expand Up @@ -143,6 +169,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-legalsylvain|

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/15.0/module_change_auto_install>`_ project on GitHub.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/module_change_auto_install>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
42 changes: 31 additions & 11 deletions module_change_auto_install/static/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ <h1 class="title">Change auto installable modules</h1>
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/module_change_auto_install"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-module_change_auto_install"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/module_change_auto_install"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-module_change_auto_install"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>In odoo, by default some modules are marked as auto installable
by the <tt class="docutils literal">auto_install</tt> key present in the manifest.</p>
<ul class="simple">
Expand Down Expand Up @@ -421,20 +421,40 @@ <h1><a class="toc-backref" href="#id2">Configuration</a></h1>
<pre class="code shell literal-block">
<span class="nv">server_wide_modules</span> <span class="o">=</span> web,module_change_auto_install

<span class="nv">modules_auto_install_disabled</span> <span class="o">=</span> partner_autocomplete,iap,mail_bot,account_edi,account_edi_facturx,account_edi_ubl
<span class="nv">modules_auto_install_disabled</span> <span class="o">=</span>
partner_autocomplete,
iap,
mail_bot

<span class="nv">modules_auto_install_enabled</span> <span class="o">=</span> web_responsive,web_no_bubble,base_technical_features,disable_odoo_online,account_menu
<span class="nv">modules_auto_install_enabled</span> <span class="o">=</span>
web_responsive:web,
base_technical_features,
disable_odoo_online,
account_usability
</pre>
<p>Run your instance and check logs. Modules that has been altered should be present in your log, at the load of your instance:</p>
<pre class="code shell literal-block">
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'iap'</span> has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'mail_bot'</span> has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'partner_autocomplete'</span> has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'account_edi'</span> has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'account_edi_facturx'</span> has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'account_edi_ubl'</span> has been marked as not auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'iap'</span> has been marked as NOT auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'mail_bot'</span> has been marked as NOT auto installable.
INFO db_name odoo.addons.module_change_auto_install.patch: Module <span class="s1">'partner_autocomplete'</span> has been marked as NOT auto installable.
INFO db_name odoo.modules.loading: <span class="m">42</span> modules loaded <span class="k">in</span> <span class="m">0</span>.32s, <span class="m">0</span> queries <span class="o">(</span>+0 extra<span class="o">)</span>
</pre>
<p><strong>Advanced Configuration Possibilities</strong></p>
<p>if your <tt class="docutils literal">odoo.cfg</tt> file contains the following configuration:</p>
<pre class="code shell literal-block">
<span class="nv">modules_auto_install_enabled</span> <span class="o">=</span>
account_usability,
web_responsive:web,
base_technical_features:,
point_of_sale:sale/purchase
</pre>
<p>The behaviour will be the following:</p>
<ul class="simple">
<li><tt class="docutils literal">account_usability</tt> module will be installed as soon as all the default dependencies are installed. (here <tt class="docutils literal">account</tt>)</li>
<li><tt class="docutils literal">web_responsive</tt> module will be installed as soon as <tt class="docutils literal">web</tt> is installed. (Althought <tt class="docutils literal">web_responsive</tt> depends on <tt class="docutils literal">web</tt> and <tt class="docutils literal">mail</tt>)</li>
<li><tt class="docutils literal">base_technical_features</tt> will be ALWAYS installed</li>
<li><tt class="docutils literal">point_of_sale</tt> module will be installed as soon as <tt class="docutils literal">sale</tt> and <tt class="docutils literal">purchase</tt> module are installed.</li>
</ul>
</div>
<div class="section" id="development">
<h1><a class="toc-backref" href="#id3">Development</a></h1>
Expand All @@ -448,7 +468,7 @@ <h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_change_auto_install%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_change_auto_install%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
Expand All @@ -474,7 +494,7 @@ <h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/module_change_auto_install">OCA/server-tools</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/module_change_auto_install">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down

0 comments on commit 707cef8

Please sign in to comment.