docs: skip changelog README.md

open-sauced · Sep 2, 2023 · fd28263 · fd28263
1 parent c7b6e33
commit fd28263
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -258,6 +258,12 @@ Unless you have a `Dockerfile` present in your root folder, this module is not a
 
 If you have a `Dockerfile` present, our config will attempt to push to `ghcr.io`.
 
+### CHANGELOG
+
+By default, a `CHANGELOG.md` file is generated and committed to document the changes introduced in releases.
+
+This can be skipped by setting `SKIP_CHANGELOG=true`.
+
 ### Environment variables
 
 Using our configuration comes with some sensible defaults: