Configuration#

Settings#

The plugin must have a configuration, located at the top directory; it can be either:

  • a YAML file named .qgis-plugin-ci

  • an INI file named setup.cfg with a [qgis-plugin-ci] section

  • a TOML file (= your actual pyproject.toml file) with a [tool.qgis-plugin-ci] section.

In the configuration, you should at least provide the following configuration:

  • plugin_path, the folder where the source code is located under the git repository. See

You can find a template .qgis-plugin-ci in this repository. You can read the docstring of the Parameters module to know parameters which are available in the file.

Conventions#

QGIS-Plugin-CI is best served if you use these two conventions :

Options#

Name

Required

Description

Example

github_organization_slug

no

The organization slug on SCM host (e.g. Github) and translation platform (e.g. Transifex).
Not required when running on Travis since deduced from $TRAVIS_REPO_SLUGenvironment variable.

plugin_path

yes

The folder where the source code is located. Shouldn’t have any dash character. Defaults to: slugify(plugin_name).

qgis_plugin_CI_testing

project_slug

no

The project slug on SCM host (e.g. Github) and translation platform (e.g. Transifex).
Not required when running on Travis since deduced from $TRAVIS_REPO_SLUGenvironment variable.

Examples#

Using YAML file .qgis-plugin-ci#

plugin_path: qgis_plugin_ci_testing
github_organization_slug: opengisch
project_slug: qgis-plugin-ci

Using INI file setup.cfg#

[qgis-plugin-ci]
plugin_path = QuickOSM
github_organization_slug = 3liz
project_slug = QuickOSM

Using TOML file pyproject.toml#

[tool.qgis-plugin-ci]
plugin_path = "qgis_plugin_ci_testing"
github_organization_slug = "opengisch"
project_slug = "qgis-plugin-ci"