From 20b773de28c0fc972ab1c9440add3e63797db344 Mon Sep 17 00:00:00 2001 From: Carlos A Becker Date: Tue, 11 Oct 2022 22:09:42 -0300 Subject: [PATCH] docs: update Signed-off-by: Carlos A Becker --- www/docs/customization/changelog.md | 10 ++++++++++ www/docs/customization/monorepo.md | 2 ++ www/docs/static/schema-pro.json | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/www/docs/customization/changelog.md b/www/docs/customization/changelog.md index 7895813bdb0..30f19561218 100644 --- a/www/docs/customization/changelog.md +++ b/www/docs/customization/changelog.md @@ -37,6 +37,16 @@ changelog: # Since: v1.11.2 abbrev: -1 + # Paths to filter the commits for. + # Only works when `use: git`, otherwise ignored. + # Only on GoReleaser Pro. + # + # Default: monorepo.dir value, or empty if no monorepo. + # Since: v1.12.0-pro + paths: + - foo/ + - bar/ + # Group commits messages by given regex and title. # Order value defines the order of the groups. # Proving no regex means all commits will be grouped under the default group. diff --git a/www/docs/customization/monorepo.md b/www/docs/customization/monorepo.md index e0508cc1408..2fe612ef0af 100644 --- a/www/docs/customization/monorepo.md +++ b/www/docs/customization/monorepo.md @@ -47,6 +47,8 @@ Then, the following is different from a "regular" run: - if yours is not, you might want to change that manually; - Extra files on the release, archives, Docker builds, etc are prefixed with `monorepo.dir`; +- If using `changelog.use: git`, only commits matching files in `monorepo.dir` + will be included in the changelog. - On templates, `{{.PrefixedTag}}` will be `monorepo.prefix/tag` (aka the actual tag name), and `{{.Tag}}` has the prefix stripped; diff --git a/www/docs/static/schema-pro.json b/www/docs/static/schema-pro.json index b9d1b79fc5b..73b055aab95 100644 --- a/www/docs/static/schema-pro.json +++ b/www/docs/static/schema-pro.json @@ -482,6 +482,12 @@ }, "abbrev": { "type": "integer" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array" } }, "additionalProperties": false,