Skip to content

docs: clarify configuration source evaluation order#788

Merged
acouvreur merged 1 commit into
mainfrom
configuration-order
Jan 14, 2026
Merged

docs: clarify configuration source evaluation order#788
acouvreur merged 1 commit into
mainfrom
configuration-order

Conversation

@acouvreur

Copy link
Copy Markdown
Member

Clarified the behavior of configuration sources regarding overriding.

Related issue #786

Clarified the behavior of configuration sources regarding overriding.

Signed-off-by: Alexis Couvreur <alexiscouvreur.pro@gmail.com>
Copilot AI review requested due to automatic review settings January 14, 2026 12:36
@sonarqubecloud

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR clarifies the configuration source evaluation order in the documentation by explicitly stating that later configuration methods override earlier ones.

Changes:

  • Added clarification text to explain that configuration sources override each other in the listed order (config file → environment variables → command-line arguments)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions

Copy link
Copy Markdown

✅ All tests successful. No failed tests were found.

📣 Thoughts on this report? Let Codecov know! | Powered by Codecov

@codecov

codecov Bot commented Jan 14, 2026

Copy link
Copy Markdown

❌ 1 Tests Failed:

Tests completed Failed Passed Skipped
182 1 181 0
View the top 1 failed test(s) by shortest run time
github.com/sablierapp/sablier/pkg/provider/podman::TestPodmanProvider_NotifyInstanceStopped
Stack Traces | 7.59s run time
Failed

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

@github-actions

Copy link
Copy Markdown
┌──────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Diff between sablier and sablier_draft_linux-amd64                                                       │
├──────────┬───────────────────────────────────────────────────────────────┬──────────┬──────────┬─────────┤
│ PERCENT  │ NAME                                                          │ OLD SIZE │ NEW SIZE │ DIFF    │
├──────────┼───────────────────────────────────────────────────────────────┼──────────┼──────────┼─────────┤
│ +100%    │ go.podman.io/storage                                          │          │ 1.5 MB   │ +1.5 MB │
│ +100%    │ go.podman.io/image/v5                                         │          │ 1.3 MB   │ +1.3 MB │
│ +18.35%  │ github.com/quic-go/quic-go                                    │ 1.0 MB   │ 1.2 MB   │ +186 kB │
│ +0.97%   │ k8s.io/client-go                                              │ 13 MB    │ 13 MB    │ +125 kB │
│ +100%    │ go.podman.io/common                                           │          │ 80 kB    │ +80 kB  │
│ +11.59%  │ go.opentelemetry.io/otel                                      │ 335 kB   │ 374 kB   │ +39 kB  │
│ +1.63%   │ golang.org/x/net                                              │ 820 kB   │ 833 kB   │ +13 kB  │
│ +0.42%   │ crypto                                                        │ 1.7 MB   │ 1.7 MB   │ +7.1 kB │
│ +0.53%   │ google.golang.org/grpc                                        │ 1.0 MB   │ 1.1 MB   │ +5.5 kB │
│ +2.58%   │ sigs.k8s.io/json                                              │ 157 kB   │ 161 kB   │ +4.0 kB │
│ +4.62%   │ github.com/containers/podman/v5                               │ 84 kB    │ 88 kB    │ +3.9 kB │
│ +0.17%   │ google.golang.org/protobuf                                    │ 1.7 MB   │ 1.7 MB   │ +3.0 kB │
│ +0.26%   │ runtime                                                       │ 896 kB   │ 898 kB   │ +2.4 kB │
│ +5.69%   │ github.com/mistifyio/go-zfs/v3                                │ 29 kB    │ 31 kB    │ +1.7 kB │
│ +1.06%   │ github.com/coreos/go-systemd/v22                              │ 84 kB    │ 84 kB    │ +883 B  │
│ +0.26%   │ github.com/go-jose/go-jose/v4                                 │ 253 kB   │ 254 kB   │ +654 B  │
│ +1.55%   │ github.com/opencontainers/selinux                             │ 34 kB    │ 35 kB    │ +533 B  │
│ +0.61%   │ github.com/kevinburke/ssh_config                              │ 64 kB    │ 64 kB    │ +389 B  │
│ +0.10%   │ math                                                          │ 295 kB   │ 295 kB   │ +300 B  │
│ +0.09%   │ github.com/gin-gonic/gin                                      │ 296 kB   │ 297 kB   │ +262 B  │
│ +0.12%   │ github.com/sablierapp/sablier                                 │ 216 kB   │ 216 kB   │ +262 B  │
│ +0.34%   │ github.com/vbatts/tar-split                                   │ 76 kB    │ 76 kB    │ +261 B  │
│ +0.30%   │ go.opentelemetry.io/auto/sdk                                  │ 82 kB    │ 82 kB    │ +242 B  │
│ +0.07%   │ slices                                                        │ 315 kB   │ 315 kB   │ +207 B  │
│ +0.02%   │ github.com/go-playground/validator/v10                        │ 310 kB   │ 310 kB   │ +74 B   │
│ +0.01%   │ github.com/goccy/go-yaml                                      │ 670 kB   │ 670 kB   │ +72 B   │
│ +0.14%   │ github.com/containers/ocicrypt                                │ 51 kB    │ 51 kB    │ +71 B   │
│ +0.05%   │ sync                                                          │ 80 kB    │ 80 kB    │ +40 B   │
│ +0.01%   │ sigs.k8s.io/structured-merge-diff/v6                          │ 263 kB   │ 263 kB   │ +33 B   │
│ +0.01%   │ github.com/pelletier/go-toml/v2                               │ 206 kB   │ 206 kB   │ +30 B   │
│ +0.01%   │ github.com/google/go-cmp                                      │ 289 kB   │ 289 kB   │ +24 B   │
│ +0.03%   │ golang.org/x/sys                                              │ 76 kB    │ 76 kB    │ +24 B   │
│ +0.02%   │ github.com/modern-go/reflect2                                 │ 136 kB   │ 136 kB   │ +24 B   │
│ +0.01%   │ github.com/fxamacker/cbor/v2                                  │ 263 kB   │ 263 kB   │ +20 B   │
│ +0.10%   │ github.com/spf13/afero                                        │ 20 kB    │ 20 kB    │ +20 B   │
│ +0.04%   │ flag                                                          │ 42 kB    │ 42 kB    │ +15 B   │
│ +0.01%   │ syscall                                                       │ 95 kB    │ 95 kB    │ +14 B   │
│ +0.02%   │ image                                                         │ 81 kB    │ 81 kB    │ +13 B   │
│ +0.01%   │ go.yaml.in/yaml/v2                                            │ 258 kB   │ 258 kB   │ +13 B   │
│ +0.03%   │ github.com/golang/protobuf                                    │ 33 kB    │ 33 kB    │ +11 B   │
│ +0.00%   │ github.com/json-iterator/go                                   │ 421 kB   │ 421 kB   │ +10 B   │
│ +0.00%   │ go.yaml.in/yaml/v3                                            │ 298 kB   │ 298 kB   │ +9 B    │
│ +0.00%   │ gopkg.in/yaml.v3                                              │ 293 kB   │ 293 kB   │ +9 B    │
│ +3.03%   │ github.com/fsnotify/fsnotify                                  │ 297 B    │ 306 B    │ +9 B    │
│ +0.01%   │ github.com/go-viper/mapstructure/v2                           │ 84 kB    │ 84 kB    │ +8 B    │
│ +0.01%   │ internal/poll                                                 │ 93 kB    │ 93 kB    │ +8 B    │
│ +0.00%   │ regexp                                                        │ 177 kB   │ 177 kB   │ +8 B    │
│ +0.02%   │ sigs.k8s.io/randfill                                          │ 35 kB    │ 35 kB    │ +8 B    │
│ +0.01%   │ fmt                                                           │ 98 kB    │ 98 kB    │ +8 B    │
│ +0.03%   │ github.com/tchap/go-patricia/v2                               │ 26 kB    │ 26 kB    │ +8 B    │
│ +0.02%   │ github.com/davecgh/go-spew                                    │ 52 kB    │ 52 kB    │ +8 B    │
│ +0.00%   │ github.com/spf13/cobra                                        │ 229 kB   │ 229 kB   │ +7 B    │
│ +0.00%   │ golang.org/x/text                                             │ 154 kB   │ 154 kB   │ +7 B    │
│ +0.01%   │ github.com/vbauerster/mpb/v8                                  │ 91 kB    │ 91 kB    │ +6 B    │
│ +0.00%   │ time                                                          │ 155 kB   │ 155 kB   │ +6 B    │
│ +0.00%   │ html                                                          │ 139 kB   │ 139 kB   │ +5 B    │
│ +0.00%   │ k8s.io/kube-openapi                                           │ 448 kB   │ 448 kB   │ +5 B    │
│ +0.05%   │ github.com/subosito/gotenv                                    │ 8.8 kB   │ 8.8 kB   │ +4 B    │
│ +0.06%   │ github.com/munnerz/goautoneg                                  │ 6.2 kB   │ 6.2 kB   │ +4 B    │
│ +0.01%   │ internal/reflectlite                                          │ 50 kB    │ 50 kB    │ +4 B    │
│ +0.04%   │ github.com/moby/sys/mountinfo                                 │ 11 kB    │ 11 kB    │ +4 B    │
│ +0.01%   │ github.com/klauspost/pgzip                                    │ 30 kB    │ 30 kB    │ +4 B    │
│ +0.02%   │ encoding/base64                                               │ 19 kB    │ 19 kB    │ +4 B    │
│ +0.00%   │ net                                                           │ 1.6 MB   │ 1.6 MB   │ +4 B    │
│ +0.01%   │ github.com/docker/distribution                                │ 44 kB    │ 44 kB    │ +4 B    │
│ +0.05%   │ github.com/modern-go/concurrent                               │ 6.2 kB   │ 6.2 kB   │ +3 B    │
│ +0.01%   │ github.com/sylabs/sif/v2                                      │ 22 kB    │ 22 kB    │ +3 B    │
│ +0.01%   │ github.com/leodido/go-urn                                     │ 56 kB    │ 56 kB    │ +3 B    │
│ +0.00%   │ os                                                            │ 208 kB   │ 208 kB   │ +3 B    │
│ +0.02%   │ internal/godebug                                              │ 9.6 kB   │ 9.6 kB   │ +2 B    │
│ +0.01%   │ github.com/sourcegraph/conc                                   │ 37 kB    │ 37 kB    │ +2 B    │
│ +0.01%   │ k8s.io/utils                                                  │ 29 kB    │ 29 kB    │ +2 B    │
│ +0.02%   │ github.com/gin-contrib/sse                                    │ 9.4 kB   │ 9.4 kB   │ +2 B    │
│ +0.00%   │ github.com/emicklei/go-restful/v3                             │ 118 kB   │ 118 kB   │ +1 B    │
│ +0.00%   │ github.com/smallstep/pkcs7                                    │ 86 kB    │ 86 kB    │ +1 B    │
│ -0.01%   │ github.com/morikuni/aec                                       │ 14 kB    │ 14 kB    │ -1 B    │
│ -0.01%   │ github.com/docker/docker-credential-helpers                   │ 7.3 kB   │ 7.3 kB   │ -1 B    │
│ -0.01%   │ github.com/pmezard/go-difflib                                 │ 16 kB    │ 16 kB    │ -1 B    │
│ -0.00%   │ github.com/spf13/viper                                        │ 66 kB    │ 66 kB    │ -2 B    │
│ -0.07%   │ golang.org/x/oauth2                                           │ 3.0 kB   │ 3.0 kB   │ -2 B    │
│ -0.00%   │ github.com/opencontainers/cgroups                             │ 121 kB   │ 121 kB   │ -4 B    │
│ -1.04%   │ github.com/go-openapi/jsonpointer                             │ 386 B    │ 382 B    │ -4 B    │
│ -0.01%   │ github.com/containers/libtrust                                │ 58 kB    │ 58 kB    │ -5 B    │
│ -0.01%   │ gopkg.in/inf.v0                                               │ 33 kB    │ 33 kB    │ -5 B    │
│ -0.06%   │ github.com/go-openapi/swag                                    │ 10 kB    │ 10 kB    │ -6 B    │
│ -0.02%   │ bytes                                                         │ 39 kB    │ 39 kB    │ -6 B    │
│ -0.02%   │ hash                                                          │ 25 kB    │ 25 kB    │ -6 B    │
│ -1.62%   │ github.com/opencontainers/image-spec                          │ 431 B    │ 424 B    │ -7 B    │
│ -1.57%   │ github.com/opencontainers/runtime-spec                        │ 446 B    │ 439 B    │ -7 B    │
│ -0.00%   │ github.com/BurntSushi/toml                                    │ 158 kB   │ 158 kB   │ -7 B    │
│ -0.01%   │ k8s.io/klog/v2                                                │ 113 kB   │ 113 kB   │ -8 B    │
│ -0.06%   │ text/tabwriter                                                │ 13 kB    │ 13 kB    │ -8 B    │
│ -0.23%   │ github.com/moby/sys/userns                                    │ 3.4 kB   │ 3.4 kB   │ -8 B    │
│ -0.01%   │ google.golang.org/genproto/googleapis/api                     │ 110 kB   │ 110 kB   │ -10 B   │
│ -0.07%   │ compress/bzip2                                                │ 14 kB    │ 14 kB    │ -10 B   │
│ -0.05%   │ github.com/google/uuid                                        │ 22 kB    │ 22 kB    │ -10 B   │
│ -0.15%   │ internal/fmtsort                                              │ 7.8 kB   │ 7.8 kB   │ -12 B   │
│ -0.01%   │ github.com/gabriel-vasile/mimetype                            │ 218 kB   │ 218 kB   │ -12 B   │
│ -0.18%   │ github.com/tniswong/go.rfcx                                   │ 8.5 kB   │ 8.5 kB   │ -15 B   │
│ -0.00%   │ github.com/docker/docker                                      │ 392 kB   │ 392 kB   │ -17 B   │
│ -0.25%   │ github.com/mattn/go-runewidth                                 │ 6.9 kB   │ 6.8 kB   │ -17 B   │
│ -0.01%   │ github.com/ulikunitz/xz                                       │ 161 kB   │ 161 kB   │ -19 B   │
│ -5.28%   │ github.com/go-openapi/jsonreference                           │ 379 B    │ 359 B    │ -20 B   │
│ -0.07%   │ vendor/golang.org/x/net/dns/dnsmessage                        │ 34 kB    │ 34 kB    │ -24 B   │
│ -0.00%   │ github.com/klauspost/compress                                 │ 490 kB   │ 490 kB   │ -24 B   │
│ -0.14%   │ github.com/stefanberger/go-pkcs11uri                          │ 18 kB    │ 18 kB    │ -24 B   │
│ -0.15%   │ golang.org/x/time                                             │ 17 kB    │ 17 kB    │ -25 B   │
│ -0.01%   │ github.com/spf13/pflag                                        │ 282 kB   │ 282 kB   │ -32 B   │
│ -0.00%   │ github.com/google/gnostic-models                              │ 1.5 MB   │ 1.5 MB   │ -32 B   │
│ -0.20%   │ github.com/google/go-intervals                                │ 21 kB    │ 21 kB    │ -42 B   │
│ -0.01%   │ github.com/godbus/dbus/v5                                     │ 329 kB   │ 329 kB   │ -43 B   │
│ -0.03%   │ encoding/json                                                 │ 161 kB   │ 161 kB   │ -52 B   │
│ -1.11%   │ github.com/skeema/knownhosts                                  │ 14 kB    │ 14 kB    │ -153 B  │
│ -18.00%  │ gopkg.in/evanphx/json-patch.v4                                │ 1.1 kB   │ 879 B    │ -193 B  │
│ -0.45%   │ github.com/sigstore/protobuf-specs                            │ 46 kB    │ 46 kB    │ -205 B  │
│ -0.26%   │ archive/tar                                                   │ 80 kB    │ 80 kB    │ -208 B  │
│ -0.10%   │ text/template                                                 │ 266 kB   │ 265 kB   │ -257 B  │
│ -0.09%   │ reflect                                                       │ 302 kB   │ 302 kB   │ -274 B  │
│ -100.00% │ github.com/opencontainers/runc                                │ 419 B    │          │ -419 B  │
│ -0.61%   │ github.com/cyphar/filepath-securejoin                         │ 82 kB    │ 81 kB    │ -498 B  │
│ -1.70%   │ github.com/samber/slog-gin                                    │ 31 kB    │ 30 kB    │ -521 B  │
│ -0.56%   │ log                                                           │ 119 kB   │ 119 kB   │ -663 B  │
│ -0.23%   │ golang.org/x/crypto                                           │ 687 kB   │ 686 kB   │ -1.6 kB │
│ -100%    │ github.com/titanous/rocacheck                                 │ 1.7 kB   │          │ -1.7 kB │
│ -0.26%   │ <autogenerated>                                               │ 734 kB   │ 733 kB   │ -1.9 kB │
│ -100%    │ github.com/letsencrypt/boulder                                │ 4.0 kB   │          │ -4.0 kB │
│ -18.51%  │ github.com/quic-go/qpack                                      │ 26 kB    │ 21 kB    │ -4.8 kB │
│ -100%    │ expvar                                                        │ 10 kB    │          │ -10 kB  │
│ -26.10%  │ go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp │ 69 kB    │ 51 kB    │ -18 kB  │
│ -100%    │ github.com/containers/common                                  │ 77 kB    │          │ -77 kB  │
│ -6.79%   │ k8s.io/apimachinery                                           │ 1.7 MB   │ 1.6 MB   │ -115 kB │
│ -100%    │ github.com/gogo/protobuf                                      │ 498 kB   │          │ -498 kB │
│ -100%    │ github.com/containers/image/v5                                │ 1.3 MB   │          │ -1.3 MB │
│ -100%    │ github.com/containers/storage                                 │ 1.5 MB   │          │ -1.5 MB │
│ -9.65%   │ k8s.io/api                                                    │ 18 MB    │ 16 MB    │ -1.7 MB │
├──────────┼───────────────────────────────────────────────────────────────┼──────────┼──────────┼─────────┤
│ -0.07%   │ .typelink                                                     │ 109 kB   │ 109 kB   │ -76 B   │
│ -2.10%   │ .go.buildinfo                                                 │ 14 kB    │ 14 kB    │ -304 B  │
│ -2.28%   │ .data                                                         │ 263 kB   │ 257 kB   │ -6.0 kB │
│ -24.86%  │ .itablink                                                     │ 37 kB    │ 28 kB    │ -9.1 kB │
│ -10.32%  │ .noptrdata                                                    │ 920 kB   │ 826 kB   │ -95 kB  │
│ -1.45%   │ .rodata                                                       │ 12 MB    │ 12 MB    │ -175 kB │
├──────────┼───────────────────────────────────────────────────────────────┼──────────┼──────────┼─────────┤
│ -3.43%   │ sablier                                                       │ 67 MB    │ 65 MB    │ -2.3 MB │
│          │ sablier_draft_linux-amd64                                     │          │          │         │
└──────────┴───────────────────────────────────────────────────────────────┴──────────┴──────────┴─────────┘

@acouvreur acouvreur merged commit ecdfd37 into main Jan 14, 2026
13 of 14 checks passed
@acouvreur acouvreur deleted the configuration-order branch January 14, 2026 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants