docs

Author: roeil

docs/input/docs/reference/configuration.md

@@ -624,6 +624,40 @@ Date and time in the format `yyyy-MM-ddTHH:mm:ss` (eg `commits-before:
 2015-10-23T12:23:15`) to setup an exclusion range. Effectively any commit before
 `commits-before` will be ignored.
 
+#### paths
+A sequence of regular expressions that represent paths in the repository. Commits that modify these paths will be excluded from version calculations. For example, to filter out commits that belong to `docs`:
+```yaml
+ignore:
+  paths:
+    - ^docs\/
+```
+##### *Monorepo*
+This ignore config can be used to filter only those commits that belong to a specific project in a monorepo. 
+As an example, consider a monorepo consisting of subdirectories for `ProjectA`, `ProjectB` and a shared `LibraryC`. For GitVersion to consider only commits that are part of `projectA` and shared library `LibraryC`, a regex that matches all paths except those starting with `ProjectA` or `LibraryC` can be used. Either one of the following configs would filter out `ProjectB`.
+* Specific match on `/ProjectB/*`:
+```yaml
+ignore:
+  paths:
+    - `^\/ProductB\/.*`
+```
+* Negative lookahead on anything other than `/ProjectA/*` and `/LibraryC/*`:
+```yaml
+ignore:
+  paths:
+    - `^(?!\/ProductA\/|\/LibraryC\/).*`
+```
+A commit having changes only in `/ProjectB/*` path would be ignored. A commit having changes in the following paths wouldn't be ignored:
+* `/ProductA/*`
+* `/LibraryC/*`
+* `/ProductA/*` and  `/LibraryC/*`
+* `/ProductA/*` and `/ProductB/*`
+* `/LibraryC/*` and `/ProductB/*`
+* `/ProductA/*` and `/ProductB/*` and `/LibraryC/*`
+
+::: {.alert .alert-warning}
+A commit is ignored by the `ignore.paths` configuration only if **all paths** changed in that commit match one or more of the specified regular expressions. If a path in a commit does not match any one of the ignore patterns, that commit will be included in version calculations.
+:::
+
 ### merge-message-formats
 
 Custom merge message formats to enable identification of merge messages that do not