Plugins downloader#

This job download plugins into QDT local folder.


Use it#

Sample job configuration in your scenario file:

  - name: Synchronize plugins
    uses: qplugins-downloader
    with:
      force: false

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

threads#

Number of threads to use for downloading.

Possible_values:

  • 1: do not use multi-thread but download plugins synchroneously

  • 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#

Add the image file to the profile folder and specify the relative filepath under the splash attribute:

{
    [...]
    "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"
        }
    [...]
}

Workflow#

  1. Create a subfolder plugins into the local QDT working directory. Default: ~/.cache/qgis-deployment-toolbelt/plugins

  2. Parse profiles downloaded by QDT (not the installed)

  3. Create an unified list of used plugins

  4. Download, if not already existing, every plugin into the plugins subfolder with this structure: plugins/{plugin-id}_{plugin-name-slufigied}_{plugin-version}.zip