docs: changelog excludes now supports the use of regexes to improve f…

…iltering (#274)

docs/changelog.md

@@ -8,10 +8,10 @@ uplift changelog
 
 ## Excluding Commits
 
-You can exclude commits from the changelog by specifying a list of commit prefixes.
+You can exclude commits from the changelog by specifying a list of regex. Matching against a commit prefix is the most straightforward approach to doing this.
 
 ```sh
-uplift changelog --exclude chore,ci,test
+uplift changelog --exclude ^chore,^ci,^test
 ```
 
 ## Changing the Commit Order

docs/reference/cli/bump.md

@@ -25,5 +25,6 @@ uplift bump [flags]
 --ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
 --ignore-shallow               ignore reported git shallow clone error
 --no-push                      no changes will be pushed to the git remote
+--no-stage                     no changes will be git staged
 --silent                       silence all logging
 ```

docs/reference/cli/changelog.md

@@ -28,5 +28,6 @@ uplift changelog [flags]
 --ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
 --ignore-shallow               ignore reported git shallow clone error
 --no-push                      no changes will be pushed to the git remote
+--no-stage                     no changes will be git staged
 --silent                       silence all logging
 ```

docs/reference/cli/release.md

@@ -32,5 +32,6 @@ uplift release [flags]
 --ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
 --ignore-shallow               ignore reported git shallow clone error
 --no-push                      no changes will be pushed to the git remote
+--no-stage                     no changes will be git staged
 --silent                       silence all logging
 ```

docs/reference/cli/root.md

@@ -19,6 +19,7 @@ uplift [command]
     --ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
     --ignore-shallow               ignore reported git shallow clone error
     --no-push                      no changes will be pushed to the git remote
+    --no-stage                     no changes will be git staged
     --silent                       silence all logging
 ```
 

docs/reference/cli/tag.md

@@ -28,5 +28,6 @@ uplift tag [flags]
 --ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
 --ignore-shallow               ignore reported git shallow clone error
 --no-push                      no changes will be pushed to the git remote
+--no-stage                     no changes will be git staged
 --silent                       silence all logging
 ```

docs/reference/config.md

@@ -145,15 +145,15 @@ changelog:
   sort: asc
 
   # A list of commits to exclude during the creation of a changelog.
-  # Provide a list of conventional commit prefixes to filter on.
-  # Auto-generated commits from Uplift (with the prefix ci(uplift)) will
-  # always be excluded
+  # Provide a list of regular expressions for matching commits that
+  # are to be excluded. Auto-generated commits from Uplift
+  # (with the prefix ci(uplift)) will always be excluded
   #
-  # Defaults to including all commits within the generated changelog
+  # Defaults to an empty list. All commits are included
   exclude:
-    - chore(deps)
-    - docs
-    - ci
+    - '^chore\(deps\)'
+    - ^docs
+    - ^ci
 ```
 
 ## bumps

docs/static/schema.json

@@ -95,7 +95,7 @@
         },
         "exclude": {
           "$comment": "https://upliftci.dev/reference/config#changelog",
-          "description": "A list of commits to exclude during the creation of a changelog. Provide a list of conventional commit prefixes to filter on. Auto-generated commits from Uplift (with the prefix ci(uplift)) will always be excluded",
+          "description": "A list of commits to exclude during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be excluded. Auto-generated commits from Uplift (with the prefix ci(uplift)) will always be excluded",
           "items": {
             "type": "string"
           },

internal/task/changelog/changelog_test.go

@@ -334,14 +334,14 @@ func TestRun_NoLogEntries(t *testing.T) {
 func TestRun_WithExcludes(t *testing.T) {
 	git.InitRepo(t)
 	git.Tag("1.0.0")
-	h := git.EmptyCommitsAndTag(t, "1.1.0", "first commit", "exclude: second commit", "third commit", "ignore: forth commit")
+	h := git.EmptyCommitsAndTag(t, "1.1.0", "first commit", "exclude(scope): second commit", "third commit", "ignore: forth commit")
 
 	var buf bytes.Buffer
 	ctx := &context.Context{
 		Out: &buf,
 		Changelog: context.Changelog{
 			DiffOnly: true,
-			Exclude:  []string{"exclude", "ignore"},
+			Exclude:  []string{`^exclude\(scope\)`, "ignore:"},
 		},
 		CurrentVersion: semver.Version{
 			Raw: "1.0.0",
@@ -483,7 +483,7 @@ func TestRun_AllWithExcludes(t *testing.T) {
 	ctx := &context.Context{
 		Changelog: context.Changelog{
 			All:     true,
-			Exclude: []string{"refactor"},
+			Exclude: []string{"^refactor:"},
 		},
 		SCM: context.SCM{
 			Provider: git.Unrecognised,