Merge pull request #8 from lumapps/handle_multi_services

handle multi services

Author: Anis

action.yml

@@ -7,6 +7,22 @@ author: 'Sébastien Boulle'
 branding:
   icon: 'bookmark'
   color: 'green'
+inputs:
+  github_token:
+    description: |
+      The github token to be used to fetch the repository
+      
+      Notes:
+         this will become required in the next version
+  tag_prefix:
+    description: if you tags follow the `prefix/version` pattern
+    required: false
+  path_filters:
+    description: |
+      A space separated list of git path blob regex to be used to filters the commits. 
+      This can be used to keep only relevant commits by filtering on relevant files.
+      Example:
+        path_filters: "src/ doc/ tests/*/qa/*"
 outputs:
   changelog:
     description: 'The generated changelog'
@@ -17,13 +33,30 @@ runs:
     - name: Generate
       id: generate
       run: |
+        # install de dependencies
         sudo apt-get install python3-wheel -y
         pip3 install -r ${{ github.action_path }}/requirements.txt
+        
+        # define the environment variables
         export PYTHONPATH=${{ github.action_path }}:$PYTHONPATH
-        export CHANGELOG=$(python3 -m changelog_generator)
-        export CHANGELOG="${CHANGELOG//'%'/'%25'}"
-        export CHANGELOG="${CHANGELOG//$'\n'/'%0A'}"
-        export CHANGELOG="${CHANGELOG//$'\r'/'%0D'}"
+        
+        # for retro-compatibility purpose. once github_token is required, then no need for the if
+        if  test ! -z "${{ inputs.github_token }}"
+        then
+          export GITHUB_TOKEN=${{ inputs.github_token }}
+        fi
+        
+        # generate the change log
+        CHANGELOG=$(python3 -m changelog_generator \
+        --tag_prefix ${{ inputs.tag_prefix }} \
+        --path_filters ${{ inputs.path_filters }} \
+        | tr '%' '%25' | tr '\n' '%0A' | tr '\r' '%0D'
+        )
+        
+        # truncate the release note to not bloat the 65536 bytes max limit
+        CHANGELOG=${CHANGELOG:0:65200}
+        
+        # output the changelog
         echo "::set-output name=changelog::$CHANGELOG"
 
       shell: bash

changelog_generator/__main__.py

@@ -1,4 +1,5 @@
 import os
+from argparse import ArgumentParser
 from typing import List, NamedTuple, Sequence
 
 from jinja2 import Environment, FileSystemLoader
@@ -55,7 +56,24 @@ def get_commit_but_types(
 
 
 def main() -> None:
-    repository = RepositoryManager("./", os.environ.get("TAG_PREFIX"))
+    parser = ArgumentParser()
+    parser.add_argument(
+        "-t",
+        "--tag_prefix",
+        nargs="?",  # optional argument
+        help="Filter tag with this prefix. Note: also available as TAG_PREFIX env var",
+    )
+    parser.add_argument(
+        "-p",
+        "--path_filters",
+        nargs="*",  # optional list
+        help="Filter commits with this semicolon separated git path regex",
+    )
+    args = parser.parse_args()
+    #
+    prefix = args.tag_prefix or os.environ.get("TAG_PREFIX")
+    filter_paths = args.path_filters
+    repository = RepositoryManager(uri="./", prefix=prefix, filter_paths=filter_paths)
 
     commits = repository.commits_since_last_tag
     trees: List[CommitTree] = []

changelog_generator/repository_manager.py

@@ -18,7 +18,11 @@ class RepositoryManager:
     organization: str = ""
     name: str = ""
 
-    def __init__(self, uri: str, prefix: str = "") -> None:
+    def __init__(
+        self, uri: str, prefix: str = None, filter_paths: Sequence[str] = None
+    ) -> None:
+        self.filter_paths = filter_paths or []
+        self.prefix = prefix
         self.repository = Repo(uri)
         self.tag_names: List[str] = []
         if self.repository.bare:
@@ -28,7 +32,6 @@ def __init__(self, uri: str, prefix: str = "") -> None:
         if res:
             self.organization = res.group("organization")
             self.name = res.group("repository")
-
         self.tag_manager = (
             PrefixedTagManager(self.repository, prefix)
             if prefix
@@ -58,7 +61,13 @@ def commits_since_last_tag(self) -> Sequence[Commit]:
         else:
             revision = self.current_tag
 
+        options = {"no_merges": True}
+        if self.filter_paths:
+            options["paths"] = self.filter_paths
+
+        commits = self.repository.iter_commits(revision, **options)
+
         return tuple(
             Commit(hexsha=commit.hexsha, summary=commit.summary, message=commit.message)
-            for commit in self.repository.iter_commits(revision, no_merges=True)
+            for commit in commits
         )

tests/conftest.py

@@ -5,6 +5,8 @@
 import pytest
 from git import Repo
 
+from changelog_generator.repository_manager import RepositoryManager
+
 
 @pytest.fixture(scope="session", autouse=True)
 def core_repo() -> Repo:

tests/test_path_filtering.py

@@ -0,0 +1,30 @@
+from pathlib import Path
+
+from git import Repo
+
+from changelog_generator.repository_manager import RepositoryManager
+
+
+def generate_service_related_paths(service: str, include_common: bool = True):
+    common_paths = [f"core/common"]
+    service_paths = [f"core/{service}"]
+    return service_paths if not include_common else common_paths + service_paths
+
+
+def test_get_cms_changelog(core_repo: Repo):
+    # GIVEN
+    path = str(Path(core_repo.git_dir).parent)
+    service = "cms"
+
+    # WHEN
+    repository = RepositoryManager(
+        path, service, generate_service_related_paths(service)
+    )
+
+    # THEN
+    current_tag = repository.current_tag
+    assert current_tag
+    previous_tag = repository.previous_tag
+    assert previous_tag
+    commits = repository.commits_since_last_tag
+    assert commits

tests/test_prefixed_tag.py

@@ -6,24 +6,16 @@
 
 
 def test_get_cms_changelog(core_repo: Repo):
+    # GIVEN
     path = str(Path(core_repo.git_dir).parent)
-    repository = RepositoryManager(path, "cms")
-    current_tag = repository.current_tag
-    assert current_tag
-    previous_tag = repository.previous_tag
-    assert previous_tag
-
-    commits = repository.commits_since_last_tag
-    assert commits
 
+    # WHEN
+    repository = RepositoryManager(path, "cms")
 
-def test_get_rbac_changelog(core_repo: Repo):
-    path = str(Path(core_repo.git_dir).parent)
-    repository = RepositoryManager(path, "rbac")
+    # THEN
     current_tag = repository.current_tag
     assert current_tag
     previous_tag = repository.previous_tag
     assert previous_tag
-
     commits = repository.commits_since_last_tag
     assert commits

tests/test_simple_tag.py

@@ -6,12 +6,16 @@
 
 
 def test_get_organization_changelog(organization_repo: Repo):
+    # GIVEN
     path = str(Path(organization_repo.git_dir).parent)
+
+    # WHEN
     repository = RepositoryManager(path)
+
+    # THEN
     current_tag = repository.current_tag
     assert current_tag
     previous_tag = repository.previous_tag
     assert previous_tag
-
     commits = repository.commits_since_last_tag
     assert commits