Skip to content

[IMP] developer/modules: deprecate 'active' and detail 'auto_install' #1427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Parent: [FIX] developer/howtos: Fixed typo from field to fields
wants to merge 1 commit into from
Closed

[IMP] developer/modules: deprecate 'active' and detail 'auto_install' #1427

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions content/developer/reference/addons/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,24 @@ Available manifest fields are:
``demo`` (``list(str)``)
List of data files which are only installed or updated in *demonstration
mode*
``auto_install`` (``bool``, default: ``False``)
``auto_install`` (``bool`` or ``list(str)``, default: ``False``)
If ``True``, this module will automatically be installed if all of its
dependencies are installed.

It is generally used for "link modules" implementing synergic integration
It is generally used for "link modules" implementing synergetic integration
between two otherwise independent modules.

For instance ``sale_crm`` depends on both ``sale`` and ``crm`` and is set
to ``auto_install``. When both ``sale`` and ``crm`` are installed, it
automatically adds CRM campaigns tracking to sale orders without either
``sale`` or ``crm`` being aware of one another
``sale`` or ``crm`` being aware of one another.

If it is a list, it must contain a subset of the dependencies. This module will automatically be
installed as soon as all the dependencies in the subset are installed. The remaining
dependencies will be automatically installed as well. If the list is empty, this module will
always be automatically installed regardless of its dependencies and these will be installed as
well.

``external_dependencies`` (``dict(key=list(str))``)
A dictionary containing python and/or binary dependencies.

Expand Down Expand Up @@ -140,7 +147,7 @@ Available manifest fields are:
These hooks should only be used when setup/cleanup required for this module
is either extremely difficult or impossible through the api.
``active`` (``bool``)
This indicates whether this module must install automatically or not.
Deprecated. Replaced by ``auto_install``.

.. _semantic versioning: https://semver.org
.. _existing categories:
Expand Down