You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

140 lines
4.9 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
  1. ==================
  2. Module Auto Update
  3. ==================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Production/Stable
  11. .. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
  13. :alt: License: LGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/11.0/module_auto_update
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  18. :target: https://runbot.odoo-community.org/runbot/149/11.0
  19. :alt: Try me on Runbot
  20. |badge1| |badge2| |badge3| |badge4|
  21. This addon provides mechanisms to compute sha1 hashes of installed addons,
  22. and save them in the database. It also provides a method that exploits these
  23. mechanisms to update a database by upgrading only the modules for which the
  24. hash has changed since the last successful upgrade.
  25. **Table of contents**
  26. .. contents::
  27. :local:
  28. Configuration
  29. =============
  30. This module supports the following system parameters:
  31. * ``module_auto_update.exclude_patterns``: comma-separated list of file
  32. name patterns to ignore when computing addon checksums. Defaults to
  33. ``*.pyc,*.pyo,i18n/*.pot,i18n_extra/*.pot,static/*``.
  34. Filename patterns must be compatible with the python ``fnmatch`` function.
  35. In addition to the above pattern, .po files corresponding to languages that
  36. are not installed in the Odoo database are ignored when computing checksums.
  37. Usage
  38. =====
  39. The main method provided by this module is ``upgrade_changed_checksum``
  40. on ``ir.module.module``. It runs a database upgrade for all installed
  41. modules for which the hash has changed since the last successful
  42. run of this method. On success it saves the hashes in the database.
  43. The first time this method is invoked after installing the module, it
  44. runs an upgrade of all modules, because it has not saved the hashes yet.
  45. This is by design, priviledging safety. Should this be an issue,
  46. the method ``_save_installed_checksums`` can be invoked in a situation
  47. where one is sure all modules on disk are installed and up-to-date in the
  48. database.
  49. An easy way to invoke this upgrade mechanism is by issuing the following
  50. in an Odoo shell session::
  51. env['ir.module.module'].upgrade_changed_checksum()
  52. Known issues / Roadmap
  53. ======================
  54. * Since version ``2.0.0``, some features have been deprecated.
  55. When you upgrade from previous versions, these features will be kept for
  56. backwards compatibility, but beware! They are buggy!
  57. If you install this addon from scratch, these features are disabled by
  58. default.
  59. To force enabling or disabling the deprecated features, set a configuration
  60. parameter called ``module_auto_update.enable_deprecated`` to either ``1``
  61. or ``0``. It is recommended that you disable them.
  62. Keep in mind that from this version, all upgrades are assumed to run in a
  63. separate odoo instance, dedicated exclusively to upgrade Odoo.
  64. * When migrating the addon to new versions, the deprecated features should be
  65. removed. To make it simple all deprecated features are found in files
  66. suffixed with ``_deprecated``.
  67. Bug Tracker
  68. ===========
  69. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  70. In case of trouble, please check there if your issue has already been reported.
  71. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
  72. Do not contact contributors directly about support or help with technical issues.
  73. Credits
  74. =======
  75. Authors
  76. ~~~~~~~
  77. * LasLabs
  78. * Juan José Scarafía
  79. * Tecnativa
  80. * ACSONE SA/NV
  81. Contributors
  82. ~~~~~~~~~~~~
  83. * Brent Hughes <brent.hughes@laslabs.com>
  84. * Juan José Scarafía <jjs@adhoc.com.ar>
  85. * Jairo Llopis <jairo.llopis@tecnativa.com>
  86. * Stéphane Bidoul <stephane.bidoul@acsone.eu> (https://acsone.eu)
  87. Maintainers
  88. ~~~~~~~~~~~
  89. This module is maintained by the OCA.
  90. .. image:: https://odoo-community.org/logo.png
  91. :alt: Odoo Community Association
  92. :target: https://odoo-community.org
  93. OCA, or the Odoo Community Association, is a nonprofit organization whose
  94. mission is to support the collaborative development of Odoo features and
  95. promote its widespread use.
  96. .. |maintainer-sbidoul| image:: https://github.com/sbidoul.png?size=40px
  97. :target: https://github.com/sbidoul
  98. :alt: sbidoul
  99. Current `maintainer <https://odoo-community.org/page/maintainer-role>`_:
  100. |maintainer-sbidoul|
  101. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/module_auto_update>`_ project on GitHub.
  102. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.