127 lines
4.8 KiB
ReStructuredText
127 lines
4.8 KiB
ReStructuredText
==================
|
|
Module Auto Update
|
|
==================
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:ba78e4d2f2c7f4ffbe7890390c9314316f8221c83f049ac48bb208a2b2e3c27e
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
|
|
:target: https://odoo-community.org/page/development-status
|
|
:alt: Production/Stable
|
|
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
|
:alt: License: LGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-tools/tree/16.0/module_auto_update
|
|
: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-16-0/server-tools-16-0-module_auto_update
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This addon provides mechanisms to compute sha1 hashes of installed addons,
|
|
and save them in the database. It also provides a method that exploits these
|
|
mechanisms to update a database by upgrading only the modules for which the
|
|
hash has changed since the last successful upgrade.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
This module supports the following system parameters:
|
|
|
|
* ``module_auto_update.exclude_patterns``: comma-separated list of file
|
|
name patterns to ignore when computing addon checksums. Defaults to
|
|
``*.pyc,*.pyo,i18n/*.pot,i18n_extra/*.pot,static/*``.
|
|
Filename patterns must be compatible with the python ``fnmatch`` function.
|
|
|
|
In addition to the above pattern, .po files corresponding to languages that
|
|
are not installed in the Odoo database are ignored when computing checksums.
|
|
|
|
Usage
|
|
=====
|
|
|
|
The main method provided by this module is ``upgrade_changed_checksum``
|
|
on ``ir.module.module``. It runs a database upgrade for all installed
|
|
modules for which the hash has changed since the last successful
|
|
run of this method. On success it saves the hashes in the database.
|
|
|
|
The first time this method is invoked after installing the module, it
|
|
runs an upgrade of all modules, because it has not saved the hashes yet.
|
|
This is by design, priviledging safety. Should this be an issue,
|
|
the method ``_save_installed_checksums`` can be invoked in a situation
|
|
where one is sure all modules on disk are installed and up-to-date in the
|
|
database.
|
|
|
|
To invoke the upgrade mechanism, navigate to *Apps* menu and use the
|
|
*Auto-Upgrade Modules* button, available only in developer mode. Restarting
|
|
the Odoo instance is highly recommended to minify risk of any possible issues.
|
|
|
|
Another easy way to invoke this upgrade mechanism is by issuing the following
|
|
in an Odoo shell session:
|
|
|
|
.. code-block:: python
|
|
|
|
env['ir.module.module'].upgrade_changed_checksum()
|
|
|
|
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 to smash it by providing a detailed and welcomed
|
|
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_auto_update%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.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* LasLabs
|
|
* Juan José Scarafía
|
|
* Tecnativa
|
|
* ACSONE SA/NV
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Brent Hughes <brent.hughes@laslabs.com>
|
|
* Juan José Scarafía <jjs@adhoc.com.ar>
|
|
* Jairo Llopis <jairo.llopis@tecnativa.com>
|
|
* Stéphane Bidoul <stephane.bidoul@acsone.eu> (https://acsone.eu)
|
|
* Eric Antones <eantones@nuobit.com>
|
|
* Manuel Engel <manuel.engel@initos.com>
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
This module is maintained by the OCA.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
|
mission is to support the collaborative development of Odoo features and
|
|
promote its widespread use.
|
|
|
|
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/module_auto_update>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|