From 04296c49cc8e3ff9b737167b5c688d0e14905de4 Mon Sep 17 00:00:00 2001
From: Mack Solomon <macksol@gmail.com>
Date: Thu, 20 Apr 2023 23:19:11 -0700
Subject: [PATCH] docs: add a doc for env overrides

---
 website/docs/configuration.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/website/docs/configuration.md b/website/docs/configuration.md
index b702917113..8f5fef60ba 100644
--- a/website/docs/configuration.md
+++ b/website/docs/configuration.md
@@ -276,3 +276,27 @@ Examples:
 `limit_commits` is a **optional** positive integer number that limits the number of included commits in the generated changelog.
 
 `limit_commits` is not part of the default configuration.
+
+### Environment Configuration Overrides
+
+It's possible to override configuration elements environment variables. If an environment variable matches a configuration element the variable's value will be used instead of the value from the config file.
+
+Examples:
+
+To override the `footer` element:
+
+```bash
+export CLIFF_GIT__CHANGELOG__FOOTER="<!-- footer from env -->"
+```
+
+To override the `ignore_tags` element:
+
+```bash
+export CLIFF_GIT__GIT__IGNORE_TAGS="v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+"
+```
+
+If it's not clear from the examples the format of config variables is
+
+```
+[PREFIX]__[CONFIG SECTION]__[FIELD NAME]
+```