qgispluginci.release module#

qgispluginci.release.create_archive(parameters: Parameters, release_version: str, archive_name: str, add_translations: bool = False, allow_uncommitted_changes: bool = False, is_prerelease: bool = False, raise_min_version: str = None, disable_submodule_update: bool = False, asset_paths: Tuple[str] = ())#

qgispluginci.release.create_plugin_repo(parameters: Parameters, release_version: str, release_tag: str, archive: str, osgeo_username: str, is_prerelease: bool = False, plugin_repo_url: str = None) → str#: Creates the plugin repo as an XML file

qgispluginci.release.release(parameters: Parameters, release_version: str, release_tag: str = None, github_token: str = None, upload_plugin_repo_github: bool = False, tx_api_token: str = None, alternative_repo_url: str = None, osgeo_username: str = None, osgeo_password: str = None, allow_uncommitted_changes: bool = False, plugin_repo_url: str = None, disable_submodule_update: bool = False, asset_paths: List[str] = [])#

Parameters#

parameters: The configuration parameters
release_version:: The release version (x.y.z)
release_tag:: The release tag (vx.y.z). If not given, the release version will be used
github_token: The Github token
upload_plugin_repo_github: If true, a custom repo will be created as a release asset on Github and could later be used in QGIS as a custom plugin repository.
plugin_repo_url: If set, this URL will be used to create the ZIP URL in the XML file
tx_api_token: The Transifex token
alternative_repo_url: URL of the endpoint to upload the plugin to
osgeo_username: osgeo username to upload the plugin to official QGIS repository
osgeo_password: osgeo password to upload the plugin to official QGIS repository
allow_uncommitted_changes: If False, uncommitted changes are not allowed before packaging/releasing. If True and some changes are detected, a hard reset on a stash create will be used to revert changes made by qgis-plugin-ci.
disable_submodule_update: If omitted, a git submodule is updated. If specified, git submodules will not be updated/initialized before packaging.

qgispluginci.release.release_is_prerelease(parameters: Parameters, release_tag: str, github_token: str) → bool#: Check the tag name or the GitHub release if the version must be experimental or not.

qgispluginci.release.upload_asset_to_github_release(parameters: Parameters, asset_path: str, release_tag: str, github_token: str, asset_name: str = None)#

qgispluginci.release.upload_plugin_to_osgeo(username: str, password: str, archive: str, server_url: str = None)#

Upload the plugin to QGIS repository

Parameters#

server_url: The plugin server URL (defaults to plugins.qgis.org)
username: The username
password: The password
archive: The plugin archive file path to be uploaded