Module

config.env_overrides

Environment-based configuration overrides.

Provides automatic baseurl detection from deployment platforms (Netlify, Vercel, GitHub Actions) for ergonomic deployments.

View source
1 Function

Functions

apply_env_overrides
Apply environment-based overrides for deployment platforms. Auto-detects baseurl from platform env…
1 dict[str, Any] 
def apply_env_overrides(config: dict[str, Any]) -> dict[str, Any]

Apply environment-based overrides for deployment platforms.

Auto-detects baseurl from platform environment variables when config baseurl is empty or missing. Provides zero-config deployments for Netlify, Vercel, and GitHub Pages.

Priority:

1) BENGAL_BASEURL (explicit override)
2) Netlify (URL/DEPLOY_PRIME_URL)
3) Vercel (VERCEL_URL)
4) GitHub Pages (owner.github.io/repo) when running in Actions
  • Set GITHUB_PAGES_ROOT=true for root deployments (user/org sites)
  • Auto-detects user/org sites when repo name is {owner}.github.io

Only applies when config baseurl is empty or missing. Explicit baseurl in config is never overridden.

Parameters 1

Name Type Default Description
config dict[str, Any] —

Configuration dictionary (flat or nested)

Returns

dict[str, Any] —

Config with baseurl set from environment if applicable