File: plugin_compatibility_settings.rst

package info (click to toggle)
errbot 6.2.0%2Bds-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,796 kB
  • sloc: python: 11,557; makefile: 164; sh: 97
file content (42 lines) | stat: -rw-r--r-- 951 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Plugin compatibility settings
=============================

Errbot compatibility
--------------------

Sometimes when your plugin breaks under a specific version of Errbot, you
might want to warn the user of your plugin and not load it.


You can do it by adding an **Errbot** section to your plug file like this:

.. code-block:: ini

    [Core]
    Name = MyPlugin
    Module = myplugin

    [Documentation]
    Description = my plugin

    [Errbot]
    Min=2.4.0
    Max=2.6.0

If the **Errbot** section is omitted, it defaults to "compatible with any version".

If the **Min** option is omitted, there is no minimum version enforced.

If the **Max** option is omitted, there is no maximum version enforced.

Versions need to be a 3 dotted one (ie 2.4 is not allowed but 2.4.0 is). And it understands
those suffixes:

- "-beta"
- "-rc1"
- "-rc2"
- etc.

For example: 2.4.0-rc1

note: -beta1 or -rc are illegal. Only rc can get a numerical suffix.