CLI Reference¶

Package and release QGIS plugins from the command line.

usage: qgis-plugin-ci [-h] [-v] [--version] [--no-validation]
                      {package,changelog,release,pull-translation,push-translation} ...

Named Arguments¶

-v, --verbose

Verbosity level: None = WARNING, -v = INFO, -vv = DEBUG

Default: 1

--version

show program’s version number and exit

--no-validation

Turn off validation of the version to be released or packaged

Default: False

commands¶

qgis-plugin-ci command

command: Possible choices: package, changelog, release, pull-translation, push-translation

Sub-commands¶

package¶

creates an archive of the plugin

qgis-plugin-ci package [-h] [--transifex-token TRANSIFEX_TOKEN]
                       [-u PLUGIN_REPO_URL] [-c] [-d] [-a ASSET_PATH]
                       [--no-repository-stylesheet]
                       release_version

Positional Arguments¶

release_version: The version to be released

Named Arguments¶

--transifex-token

The Transifex API token. If specified translations will be pulled and compiled.

-u, --plugin-repo-url

If specified, a XML repository file will be created in the current directory, the zip URL will use this parameter.

-c, --allow-uncommitted-changes

If omitted, uncommitted changes are not allowed before packaging. If specified and some changes are detected, a hard reset on a stash create will be used to revert changes made by qgis-plugin-ci.

Default: False

-d, --disable-submodule-update

If omitted, a git submodule is updated. If specified, git submodules will not be updated/initialized before packaging.

Default: False

-a, --asset-path

An additional asset path to add. Can be specified multiple times.

--no-repository-stylesheet

Do not embed the XSL stylesheet reference in the generated plugins.xml.

Default: False

changelog¶

gets the changelog content

qgis-plugin-ci changelog [-h] release_version

Positional Arguments¶

release_version

The version to be released. If nothing is specified, the latest version specified into the changelog is used.

Default: 'latest'

release¶

release the plugin

qgis-plugin-ci release [-h] [--release-tag RELEASE_TAG]
                       [--transifex-token TRANSIFEX_TOKEN]
                       [--github-token GITHUB_TOKEN] [-r]
                       [--no-repository-stylesheet] [-c] [-d] [-a ASSET_PATH]
                       [--alternative-repo-url ALTERNATIVE_REPO_URL]
                       [--qgis-token QGIS_TOKEN]
                       [--osgeo-username OSGEO_USERNAME]
                       [--osgeo-password OSGEO_PASSWORD]
                       release_version

Positional Arguments¶

release_version: The version to be released (x.y.z).

Named Arguments¶

--release-tag

The release tag, if different from the version (e.g. vx.y.z).

--transifex-token

The Transifex API token. If specified translations will be pulled and compiled.

--github-token

The Github API token. If specified, the archive will be pushed to an already existing release.

-r, --create-plugin-repo

Will create a XML repo as a Github release asset. Github token is required.

Default: False

--no-repository-stylesheet

Do not embed the XSL stylesheet reference in the generated plugins.xml.

Default: False

-c, --allow-uncommitted-changes

If omitted, uncommitted changes are not allowed before releasing. If specified and some changes are detected, a hard reset on a stash create will be used to revert changes made by qgis-plugin-ci.

Default: False

-d, --disable-submodule-update

If omitted, a git submodule is updated. If specified, git submodules will not be updated/initialized before packaging.

Default: False

-a, --asset-path

An additional asset path to add. Can be specified multiple times.

--alternative-repo-url

The URL of the endpoint to publish the plugin (defaults to plugins.qgis.org)

--qgis-token

The token from https://plugins.qgis.org to publish the plugin. Incompatible with the OSGeo user name.

--osgeo-username

The OSGeo user name to publish the plugin. Incompatible with QGIS token.

--osgeo-password

The OSGeo password to publish the plugin. Incompatible with QGIS token.

pull-translation¶

pull translations from Transifex

qgis-plugin-ci pull-translation [-h] [--compile] transifex_token

Positional Arguments¶

transifex_token: The Transifex API token

Named Arguments¶

--compile

Will compile TS files into QM files

Default: False

push-translation¶

update strings and push translations

qgis-plugin-ci push-translation [-h] transifex_token

Positional Arguments¶

transifex_token: The Transifex API token