Added ability to use the current branch in release hint rules

Author: coordt

.changelog-config.yaml

@@ -99,3 +99,29 @@ valid_author_tokens:
   - helped-by
   - improved-by
   - original-patch-by
+
+# Rules applied to commits to determine the type of release to suggest.
+release_hint_rules:
+  - match_result: dev
+    no_match_result: no-release
+    branch: ^((?!master|main).)*$
+  - match_result: patch
+    no_match_result: no-release
+    grouping: Other
+    branch: master|main
+  - match_result: patch
+    no_match_result: no-release
+    grouping: Fixes
+    branch: master|main
+  - match_result: minor
+    no_match_result: no-release
+    grouping: Updates
+    branch: master|main
+  - match_result: minor
+    no_match_result:
+    grouping: New
+    branch: master|main
+  - match_result: major
+    no_match_result:
+    grouping: Breaking Changes
+    branch: master|main

docsrc/release-hinting.md

@@ -19,15 +19,15 @@ patch
 
 ## Release rules
 
-There are four parts to a release rule: `match_result`, `no_match_result`, `grouping` and `path`. Only `match_result` is required, but without a `grouping` or `path` value, the rule is ignored. `no_match_result` defaults to `no-release`.
+There are five parts to a release rule: `match_result`, `no_match_result`, `grouping`, `path`, and `branch`. Only `match_result` is required, but without a `grouping`, `path`, or `branch` value, the rule is ignored. `no_match_result` defaults to `no-release`.
 
 ### Match result
 
-This is the hint returned if both the `grouping` and `path` values match. This is required.
+This is the hint returned if the `grouping`, `path` and `branch` evaluations return `True`. This is required.
 
 ### No match result
 
-This is the hint returned if either the `grouping` or `path` values do not match. By default, this is `no-release`.
+This is the hint returned if any of the `grouping`, `path`, or `branch` evaluations return `False`. By default, this is `no-release`.
 
 ### Grouping
 
@@ -51,13 +51,32 @@ The value of {attr}`.ReleaseHint.grouping` will match the {attr}`.CommitContext.
 
 The {attr}`.CommitContext.files` attribute is a `set` of paths relative to the repository root. The {attr}`.ReleaseHint.path` uses [globbing patterns](https://www.malikbrowne.com/blog/a-beginners-guide-glob-patterns) to match against {attr}`.CommitContext.files`.
 
+### Branch
+
+The {attr}`.ReleaseHint.branch` is a regular expression matched against the current branch. You can limit some release types to your primary branch, and others to non-primary branches.
+
 ## Examples
 
-This will provide a "patch" hint if the grouping contains "Other", but only when a modified file is within the `src` directory. Otherwise it will provide a "no-release" hint.
+This will provide a `patch` hint if the grouping contains "Other", but only when a modified file is within the `src` directory and the current branch is either `master` or `main`. Otherwise, it will provide a "no-release" hint.
 
 ```yaml
-- match_result: "patch"
-  no_match_result: "no-release"
-  grouping: "Other"
+- match_result: patch
+  no_match_result: no-release
+  grouping: Other
   path: src/*
+  branch: master|main
+```
+This will provide a `dev` hint if the current branch is not `master` or `main`. For this to work all other rules must also specify a `branch` attribute. For example, `branch: master|main`.
+
+```yaml
+- match_result: dev
+  no_match_result: no-release
+  branch: ^((?!master|main).)*$
+```
+This will prevent any type of release if the current branch is not `master` or `main`. For this to work all other rules must also specify a `branch` attribute. For example, `branch: master|main`.
+
+```yaml
+- match_result: no-release
+  no_match_result: no-release
+  branch: ^((?!master|main).)*$
 ```

generate_changelog/cli.py

@@ -84,6 +84,8 @@ def main(
     else:
         repository = Repo(search_parent_directories=True)
 
+    current_branch = repository.active_branch
+
     # get starting tag based configuration if not passed in
     if not starting_tag and config.starting_tag_pipeline:
         start_tag_pipeline = pipeline_factory(config.starting_tag_pipeline, **config.variables)
@@ -96,7 +98,7 @@ def main(
 
     version_contexts = get_context_from_tags(repository, config, starting_tag)
 
-    release_hint = suggest_release_type(version_contexts, config)
+    release_hint = suggest_release_type(current_branch.name, version_contexts, config)
 
     # use the output pipeline to deal with the rendered change log.
     notes = templating.render_changelog(version_contexts, config, not starting_tag)

generate_changelog/configuration.py

@@ -136,30 +136,40 @@
 DEFAULT_TEMPLATE_DIRS = [".github/changelog_templates/"]
 
 DEFAULT_RELEASE_RULES = [
+    {
+        "match_result": "dev",
+        "no_match_result": "no-release",
+        "branch": "^((?!master|main).)*$",
+    },
     {
         "match_result": "patch",
         "no_match_result": "no-release",
         "grouping": "Other",
+        "branch": "master|main",
     },
     {
         "match_result": "patch",
         "no_match_result": "no-release",
         "grouping": "Fixes",
+        "branch": "master|main",
     },
     {
         "match_result": "minor",
         "no_match_result": "no-release",
         "grouping": "Updates",
+        "branch": "master|main",
     },
     {
         "match_result": "minor",
         "no_match_result": None,
         "grouping": "New",
+        "branch": "master|main",
     },
     {
         "match_result": "major",
         "no_match_result": None,
         "grouping": "Breaking Changes",
+        "branch": "master|main",
     },
 ]
 

generate_changelog/release_hint.py

@@ -23,6 +23,7 @@ def __init__(
         no_match_result: Optional[str] = "no-release",
         grouping: Union[str, tuple, list, None] = None,
         path: Optional[str] = None,
+        branch: Optional[str] = None,
     ):
         """
         Initialize the callable rule.
@@ -32,12 +33,14 @@ def __init__(
             no_match_result: Release type if a commit context doesn't match the rule.
             grouping: The partial or exact grouping of the commit context
             path: A globbing pattern that matches against files included in the commit
+            branch: A regular expression pattern to match against the branch
         """
         self.match_result = match_result
         self.no_match_result = no_match_result
         self.grouping = grouping if grouping != "*" else None
         self.path = path if path != "*" else None
-        self.is_valid = any([self.path, self.grouping])
+        self.branch = branch or None
+        self.is_valid = any([self.path, self.grouping, self.branch])
 
     def matches_grouping(self, commit: CommitContext) -> bool:
         """
@@ -88,14 +91,27 @@ def matches_path(self, commit: CommitContext) -> bool:
         re_pattern = fnmatch.translate(self.path)
         return any(re.match(re_pattern, p) for p in commit.files)
 
-    def __call__(self, commit: CommitContext) -> Optional[str]:
+    def matches_branch(self, current_branch: str) -> bool:
+        """
+        Does the current branch match the rule?
+
+        Args:
+            current_branch: The name of the current branch
+
+        Returns:
+            ``True`` if the current branch matches or if ``self.branch`` is ``None``
+        """
+        return bool(re.match(self.branch, current_branch)) if self.branch else True
+
+    def __call__(self, commit: CommitContext, current_branch: str) -> Optional[str]:
         """Evaluate the commit using this rule."""
         if not self.is_valid:
             raise InvalidRuleError()
 
         matches_grouping = self.matches_grouping(commit)
         matches_path = self.matches_path(commit)
-        return self.match_result if matches_grouping and matches_path else self.no_match_result
+        matches_branch = self.matches_branch(current_branch)
+        return self.match_result if all([matches_grouping, matches_path, matches_branch]) else self.no_match_result
 
 
 class RuleProcessor:
@@ -110,17 +126,18 @@ def __init__(self, rule_list: List[dict]):
         """
         self.rules = [ReleaseRule(**kwargs) for kwargs in rule_list]
 
-    def __call__(self, commit: CommitContext) -> Optional[str]:
+    def __call__(self, commit: CommitContext, current_branch: str) -> Optional[str]:
         """
         Return the result of applying all the rules to a commit.
 
         Args:
             commit: The commit context to apply rules to
+            current_branch: The name of the current branch
 
         Returns:
             The release hint
         """
-        suggestions = {rule(commit) for rule in self.rules}
+        suggestions = {rule(commit, current_branch) for rule in self.rules}
         unknown_suggestions = suggestions - set(RELEASE_TYPE_ORDER)
         if unknown_suggestions:
             return unknown_suggestions.pop()  # Return a random value from the unknowns
@@ -129,11 +146,12 @@ def __call__(self, commit: CommitContext) -> Optional[str]:
         return sorted_suggestions[-1]
 
 
-def suggest_release_type(version_contexts: List[VersionContext], config: Configuration) -> str:
+def suggest_release_type(current_branch: str, version_contexts: List[VersionContext], config: Configuration) -> str:
     """
     Suggest the type of release based on the unreleased commits.
 
     Args:
+        current_branch: The name of the current branch
         version_contexts: The processed commits to process
         config: The current configuration
 
@@ -148,7 +166,7 @@ def suggest_release_type(version_contexts: List[VersionContext], config: Configu
 
     suggestions = set()
     for commit_group in version_contexts[0].grouped_commits:
-        suggestions |= {rule_processor(commit) for commit in commit_group.commits}
+        suggestions |= {rule_processor(commit, current_branch) for commit in commit_group.commits}
 
     if not suggestions:
         return "no-release"

requirements/dev.txt

@@ -1,4 +1,5 @@
 -r test.txt
 -r docs.txt
 bump2version>=1.0.1
+generate-changelog
 git-fame>=1.12.2

test/conftest.py

@@ -106,7 +106,7 @@ def commit_factory(
 @pytest.fixture
 def bare_git_repo(tmp_path):
     """Create a temporary bare git repository."""
-    return Repo.init(tmp_path / "bare-repo", bare=True)
+    return Repo.init(tmp_path / "bare-repo", bare=True, initial_branch="master")
 
 
 @pytest.fixture