Plugins downloader¶

This job download QGIS plugins into QDT local folder.

Use it¶

Sample job configuration in your scenario file:

  - name: Download plugins to QDT working folder
    uses: qplugins-downloader
    with:
      force: false
      threads: 5

Options¶

force¶

Controls download mode.

Possible_values:

false (default): download only plugins which are not present into the local QDT folder
true: download every plugin referenced in profile.json files into the local QDT folder, even if the archive is already here. Useful when a previous download failed and the local file is corrupted.

threads¶

Number of threads to use for downloading.

Possible_values:

1: do not use multi-thread but download plugins synchroneously. useful if things go wrong during plugins download.
2, 3, 4 or 5 (default): number of threads to parallelize plugins download

How does it work¶

Specify the file to use in the `profile.json`¶

Here come a few examples on how to reference plugins in a profile:

{
    [...]
    "plugins": [
        {
            "name": "french_locator_filter",
            "version": "1.0.4",
            "official_repository": true,
            "plugin_id": 1846
        },
        {
            "name": "pg_metadata",
            "version": "1.2.1",
            "url": "https://plugins.qgis.org/plugins/pg_metadata/version/1.2.1/download/",
            "location": "remote",
            "official_repository": true,
        },
        {
            "name": "Geotuileur",
            "version": "1.0.0",
            "url": "https://oslandia.gitlab.io/qgis/ign-geotuileur/geotuileur.1.0.0.zip",
            "location": "remote",
            "official_repository": false,
            "repository_url_xml": "https://oslandia.gitlab.io/qgis/ign-geotuileur/plugins.xml"
        },
        {
            "folder_name": "internal_qgis_tools",
            "location": "remote",
            "name": "q-common-internal",
            "official_repository": false,
            "repository_url_xml": "https://sigweb.local/qgis/plugins/plugins.xml",
            "plugin_id": 9951,
            "url": "https://sigweb.local/qgis/plugins/qommon-tools.2.1.5.zip",
            "version": "2.1.5"
        }

    [...]
}

Workflow¶

Create a subfolder plugins into the local QDT working directory. Default: ~/.cache/qgis-deployment-toolbelt/plugins
Parse profiles downloaded by QDT (not the installed)
Create an unified list of used plugins
Download, if not already existing, every plugin into the plugins subfolder with this structure: plugins/{plugin-id}_{plugin-name-slufigied}_{plugin-version}.zip