feat(jobs): add new job `qglobal-config-manager` for qgis_global_settings.ini copy by jmkerloch · Pull Request #781 · qgis-deployment/qgis-deployment-toolbelt-cli

jmkerloch · 2026-03-23T09:58:14Z

QGIS global config manager

qgis_global_settings.ini file contains global settings for all QGIS profile.

This PR introduces a new job qglobal-config-manager that can be added to a scenario to use a custom file during deployment :

  - name: Handle the qgis_global_settings.ini file
    uses: qglobal-config-manager
    with:
      src: ./global/qgis_global_settings.ini
      dst: ~/config/qgis/global_settings.ini

The job handles:

conversion of src and dst for environment variable use
download of the src .ini file if the input is an url
copy of the src .ini file to the dst .ini file
conversion of environment variable in the src .ini
define QGIS_GLOBAL_SETTINGS_FILE user environment variable with dst .ini file path

Default values

If no value defined in jobs, default values are used. The value is defined with the same behavior as QGIS :

first use QGIS_GLOBAL_SETTINGS_FILE
if not defined, use AppDataLocation folder:
- Linux: $HOME/.local/share/QGIS/QGIS3/
- Windows : C:\Users\<username>\%AppData%\Roaming\QGIS\QGIS3\
- MacOS : $HOME/Library/Application Support/QGIS/QGIS3/
if file doesn't exists :
- the installation directory, i.e., your_QGIS_package_path/resources/qgis_global_settings.ini
- to define the QGIS package path we use QDT_QGIS_EXE_PATH environment variable

Relative `src` option

src can be a relative path. In this case we check for .ini file related to:

repository folder from current scenario
- when the job qprofiles-synchronizer is run, all profiles repository are stored in a local repositories folder : <qdt_working_folder>/respositories/<scenario_id>
- .ini file can be stored in profile repository and defined with a relative src : ./myprofile/qgis_global_settings.ini
qdt local working directory.
- can be defined with QDT_LOCAL_WORK_DIR environment variable

Funded by ANFSI (cc @Niarolf ).

codecov · 2026-03-23T10:00:06Z

Codecov Report

❌ Patch coverage is 84.82143% with 17 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...oyment_toolbelt/jobs/job_qglobal_config_manager.py	86.20%	9 Missing and 3 partials ⚠️
qgis_deployment_toolbelt/constants.py	70.58%	1 Missing and 4 partials ⚠️

@@            Coverage Diff             @@
##             main     #781      +/-   ##
==========================================
+ Coverage   73.24%   73.89%   +0.65%     
==========================================
  Files          50       51       +1     
  Lines        3509     3620     +111     
  Branches      621      640      +19     
==========================================
+ Hits         2570     2675     +105     
- Misses        707      709       +2     
- Partials      232      236       +4

Flag	Coverage Δ
unittests	`73.23% <83.92%> (+0.64%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
qgis_deployment_toolbelt/jobs/orchestrator.py	`90.90% <100.00%> (+0.28%)`	⬆️
...s_deployment_toolbelt/profiles/qgis_ini_handler.py	`72.61% <100.00%> (+4.10%)`	⬆️
qgis_deployment_toolbelt/constants.py	`78.94% <70.58%> (-1.23%)`	⬇️
...oyment_toolbelt/jobs/job_qglobal_config_manager.py	`86.20% <86.20%> (ø)`

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jmkerloch · 2026-03-24T08:22:35Z

@Guts examples/scenarios/demo-scenario-global-config.qdt.yml will be updated before merge to indicate main branch. I keep feat/qglobal_config_manager now for test purpose.

Guts · 2026-03-24T17:49:56Z

@jmkerloch can you add the corresponding JSON schema into https://github.com/qgis-deployment/qgis-deployment-toolbelt-cli/tree/feat/qglobal_config_manager/docs/schemas/scenario/jobs please?

jmkerloch · 2026-03-26T15:29:13Z

@jmkerloch can you add the corresponding JSON schema into https://github.com/qgis-deployment/qgis-deployment-toolbelt-cli/tree/feat/qglobal_config_manager/docs/schemas/scenario/jobs please?

For sure 🕶️ I added a commit.

Guts

First review mainly reading documentation and code.
Next: try locally.

- from qdt local working dir - from qdt downloaded repository

…rectory for copy fail

…qgis .ini

Co-authored-by: Julien <1596222+Guts@users.noreply.github.com> Signed-off-by: Julien <1596222+Guts@users.noreply.github.com>

…ation for QGIS global settings file

Util has been introduced in #830 Funded by Oslandia

…ts depending on current operating system Util has been introduced in #833 Funded by ANFSI

sonarqubecloud · 2026-05-31T13:32:52Z

Quality Gate passed

Issues
4 New issues
2 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-07-24T04:27:07Z

Quality Gate passed

Issues
28 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

        environ.pop("QGIS_CUSTOM_CONFIG_PATH")
        unsetenv("QGIS_CUSTOM_CONFIG_PATH")

+    def test_get_qgis_global_settings_file(self):


+                Path(expandvars("%APPDATA%/QGIS/QGIS3/qgis_global_setting.ini")),
+            )
+
+    def test_get_qgis_global_settings_file_custom(self):


+        environment variable for file use in QGIS."""
+
+        # Define source file
+        src_path = self.get_src_ini_file(self.options.get("src", None))


jmkerloch self-assigned this Mar 23, 2026

github-actions Bot added jobs Scenarios and jobs quality Tests, project resiliency, etc. labels Mar 23, 2026

github-actions Bot added the documentation Improvements or additions to documentation label Mar 23, 2026

jmkerloch changed the title ~~Feat/qglobal config manager~~ feat(jobs): add new job qglobal-config-manager for qgis_global_settings.ini copy Mar 23, 2026

jmkerloch marked this pull request as ready for review March 23, 2026 16:21

jmkerloch marked this pull request as draft March 23, 2026 17:04

jmkerloch force-pushed the feat/qglobal_config_manager branch from 703c4f5 to 1bb727d Compare March 24, 2026 08:16

jmkerloch marked this pull request as ready for review March 24, 2026 08:21

jmkerloch requested a review from Guts March 24, 2026 08:22

jmkerloch force-pushed the feat/qglobal_config_manager branch from aa60943 to cfac0c7 Compare March 26, 2026 15:27

jmkerloch force-pushed the feat/qglobal_config_manager branch from cfac0c7 to 5334868 Compare April 2, 2026 14:44

Guts force-pushed the feat/qglobal_config_manager branch 3 times, most recently from 09c52e7 to e2be9ce Compare May 4, 2026 16:52

Guts reviewed May 4, 2026

View reviewed changes

Guts assigned Guts and unassigned jmkerloch May 4, 2026

Guts added the enhancement New feature or request label May 4, 2026

Guts force-pushed the feat/qglobal_config_manager branch 6 times, most recently from b59969e to dd24ebd Compare May 6, 2026 06:47

Guts mentioned this pull request May 6, 2026

fix(jobs): options validation was using bad condition type to raise error #824

Merged

6 tasks

jmkerloch and others added 22 commits May 31, 2026 15:32

feat(global config): use relative path for src

873b1c2

- from qdt local working dir - from qdt downloaded repository

feat(global config): destination must be absolute

66213ec

fix(test): update tmp scenario id for relative src and use special di…

773919c

…rectory for copy fail

feat(global config): allow url use in src option

884cd3f

feat(test): add tests for fallback values of qgis_global_setting_path

eb17eaf

feat(global config): add interpolation for src .ini file

30bb2a2

test(qgis ini): add test for new qgis_global_settings type and non …

c065651

…qgis .ini

feat(global config): add documentation

7bf1fa0

feat(global config): convert environment variable for src and dst option

cc2aa93

feat(global config): refactor code

407adaf

feat(global config): add JobGlobalConfigManager to JobsOrchestrator

e373e55

feat(global config): add logs for relative path conversion

4e0d89e

doc(global config): precision for qdt run directory relative path

de02113

feat(examples): add example with global config use (for now branch use)

9326b0d

feat(global config): add json schema

5b5fd0b

Apply suggestions from code review

965059b

Co-authored-by: Julien <1596222+Guts@users.noreply.github.com> Signed-off-by: Julien <1596222+Guts@users.noreply.github.com>

update(qconfig-global): renaming and consistency minor changes

397bffb

update(docs): add sample with remote HTTP(s) file

e32b4f9

update(constants): missing docstring

c0b4b35

update(docs): add snippet to use system env vars as source and destin…

b5464fe

…ation for QGIS global settings file

improve(qconfig-global): use util to determine filename from remote URL

6a1b667

Util has been introduced in #830 Funded by Oslandia

improve(qconfig-global): use util router to manager conditional impor…

03864bc

…ts depending on current operating system Util has been introduced in #833 Funded by ANFSI

Guts force-pushed the feat/qglobal_config_manager branch from b817216 to 03864bc Compare May 31, 2026 13:32

Guts modified the milestones: 0.43.1, 0.44.0 Jun 2, 2026

jmkerloch and others added 2 commits July 24, 2026 06:26

feat(constants): add qgis_global_settings_file_path from opersys

82d3945

wip

b71ff76

github-code-quality Bot found potential problems Jul 24, 2026

View reviewed changes

Navigation Menu

Uh oh!

feat(jobs): add new job `qglobal-config-manager` for qgis_global_settings.ini copy - #781

feat(jobs): add new job `qglobal-config-manager` for qgis_global_settings.ini copy#781
jmkerloch wants to merge 30 commits into
mainfrom
feat/qglobal_config_manager

jmkerloch commented Mar 23, 2026 •

edited by Guts

Loading

Uh oh!

codecov Bot commented Mar 23, 2026 •

edited

Loading

Uh oh!

jmkerloch commented Mar 24, 2026

Uh oh!

Guts commented Mar 24, 2026

Uh oh!

jmkerloch commented Mar 26, 2026

Uh oh!

Guts left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 31, 2026

Uh oh!

sonarqubecloud Bot commented Jul 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

jmkerloch commented Mar 23, 2026 • edited by Guts Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QGIS global config manager

Default values

Relative src option

Uh oh!

codecov Bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jmkerloch commented Mar 24, 2026

Uh oh!

Guts commented Mar 24, 2026

Uh oh!

jmkerloch commented Mar 26, 2026

Uh oh!

Guts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 31, 2026

Quality Gate passed

Uh oh!

sonarqubecloud Bot commented Jul 24, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jmkerloch commented Mar 23, 2026 •

edited by Guts

Loading

Relative `src` option

codecov Bot commented Mar 23, 2026 •

edited

Loading