Environment variables manager

Use this job to set/delete environment variables. For example to set a value for a QGIS environment variable or to set a parameter which is used by a plugin.

Compatibility

This job is compatible with:

  • Windows: storing environment variables in registry

  • Linux (bash): storing environment variables in ~/.profile for scope=user and /etc/profile.d/qdt for scope=system.

Use it

Sample job configuration in your scenario file:

- name: Set environment variables
  uses: manage-env-vars
  with:
    - name: QGIS_GLOBAL_SETTINGS_FILE
      action: "add"
      scope: "user"
      value: "\\SIG\\QGIS\\CONFIG\\qgis_global_settings.ini"
      value_type: path
    - name: PROFILES_RESSOURCES_PATH
      action: "add"
      scope: "user"
      value: "%USERPROFILE%/QGIS profiles ressources"
      value_type: path
      qgis_ini_use: true

Options

action

Tell the job what to do with the environment variable:

Possible_values:

  • add: add environment variable

  • remove: remove environment variable

name

Name of the environment variable.

scope

Level of the environment variable.

Possible_values:

  • system: environment variable is set at system level. QDT needs to be run as administrator.

  • user: environment variable is set at user level. Default value.

value

Value to set to the environment variable.

value_type

Value type to avoid ambiguity.

Possible_values:

  • bool: a boolean (True, true, False, false, 0, 1)

  • path: a valid local path (user and variables expansion are supported)

  • str: a raw and simple string. Default value.

  • url: an HTTP/S URL

qgis_ini_use

Indicate that environnement variable will be used in QGIS .ini file.

Possible_values:

  • True

  • False

When a path value in a QGIS .ini file contains a user environment variable (e.g., %USERPROFILE%) on Windows, the variable may not be expanded correctly. The expanded environment variable will use backslash for path definition which is not supported by QGIS when reading .ini files. When using backslashes in .ini files, it must be doubled.

Example:

searchPathsForSVG=$PROFILES_RESSOURCES_PATH/QGIS_SVG

steps:
  - name: Set environment variables
    uses: manage-env-vars
    with:
      - name: PROFILES_RESSOURCES_PATH
        action: "add"
        scope: "user"
        value: "%USERPROFILE%/QGIS profiles ressources"
        value_type: path

Result:

searchPathsForSVG = C:\User\jmker/QGIS profiles ressources

Simple backslashes are not supported by QGIS when reading .ini file and the settings will be broken.

searchPathsForSVG = C:sersmker/QGIS profiles ressources

You need to update your environnement variable to use qgis_ini_use option :

steps:
  - name: Set environment variables
    uses: manage-env-vars
    with:
      - name: PROFILES_RESSOURCES_PATH
        action: "add"
        scope: "user"
        value: "%USERPROFILE%/QGIS profiles ressources"
        value_type: path
        qgis_ini_use: True

Result:

searchPathsForSVG = C:/User/jmker/QGIS profiles ressources

Note

You can still use a mix of double backslashes or slashes for your path definition but you must not use simple backslash.