Plugins synchronizer¶
This job synchronize plugins between those stored locally (typically downloaded by the Plugins Downloader job) and the installed plugins.
Use it¶
Sample job configuration in your scenario file:
- name: Synchronize plugins
uses: qplugins-synchronizer
with:
force: false
Options¶
action¶
Tell the job what to do with plugins in installed profiles:
Possible_values:
create
: add plugins if they are not presentcreate_or_restore
: add plugins if not present and replace eventual existing oneremove
: remove plugins which are not listed
profile_ref¶
Which profile.json
file to use as reference.
Possible_values:
downloaded
: read plugins from the local downloaded (synchronized) profiles before they are copied in to the user QGIS 3 data.installed
: read plugins from the installed profiles (folders in user data QGIS3). Useful when using a scenario without theqprofiles-manager
job. Be careful: if the end-user edits the profile.json file located directly into the QGIS profile folder to control the plugins synchronization.
Default: ~/.cache/qgis-deployment-toolbelt/plugins
source¶
Where to find plugins zip files.
Possible_values: a valid path to an existing folder
Default: ~/.cache/qgis-deployment-toolbelt/plugins
How does it work¶
Workflow¶
List plugins archives into the source folder. Default:
~/.cache/qgis-deployment-toolbelt/plugins
Parse profiles installed
Compare plugin versions between referenced in profile.json and the one installed
If version plugin in installed profile is inferior, unzip the download plugin in installed profiles