Skip to content

manifest-maintainers-list (ODE8104)

Preview (since 0.16.2.2) · Related issues · View source

Derived from the odoo linter.

Fix is sometimes available.

This rule is unstable and in preview. The --preview flag is required for use.

What it does

Checks that the maintainers key in an Odoo module's __manifest__.py, if present, is a list of strings.

Why is this bad?

Odoo expects maintainers to be a list of GitHub usernames (strings).

Example

{
    "maintainers": "someone",
}

Use instead: 

{
    "maintainers": ["someone"],
}

Fix safety

The fix wraps a single string in a list, and rewrites a tuple of strings as a list. It is marked as unsafe because other tooling reading the manifest may expect the original value. No fix is offered for other values, or for a string containing a comma — that probably names several maintainers, and how to split them is a judgment call.