Merge pull request #11 from lumapps/rewrite_release_note

chore(rewrite-existing): rewrite existing release note

Author: Anis

.github/workflows/validate_pr.yml

@@ -23,12 +23,18 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+      - run: |
+          # create the master branch
+          git branch ${{ github.base_ref }} origin/${{ github.base_ref }}
+          # create the pr branch
+          git branch ${{ github.head_ref }} origin/${{ github.head_ref }}
       - name: Generate changelog
         id: generate_changelog
         uses: ./
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           path_filters: "changelog_generator/"
+          target: ${{ github.base_ref }}..${{ github.head_ref }}
       - uses: kanga333/comment-hider@bbdf5b562fbec24e6f60572d8f712017428b92e0
         name: Hide previous comments
         with:

action.yml

@@ -23,6 +23,8 @@ inputs:
       This can be used to keep only relevant commits by filtering on relevant files.
       Example:
         path_filters: "src/ doc/ tests/*/qa/*"
+  target:
+    description: A rev1..rev2 string to be used to generate the commit list
 outputs:
   changelog:
     description: 'The generated changelog'
@@ -52,7 +54,8 @@ runs:
         # generate the change log
         CHANGELOG=$(python3 -m changelog_generator \
         --tag_prefix ${{ inputs.tag_prefix }} \
-        --path_filters ${{ inputs.path_filters }}
+        --path_filters ${{ inputs.path_filters }} \
+        --target ${{ inputs.target }}
         )
         
         # truncate the release note to not bloat the 65536 bytes max limit

changelog_generator/__main__.py

@@ -1,58 +1,7 @@
 import os
 from argparse import ArgumentParser
-from typing import List, NamedTuple, Sequence
 
-from jinja2 import Environment, FileSystemLoader
-
-from changelog_generator.commit import Commit
-from changelog_generator.repository_manager import RepositoryManager
-
-
-class CommitTree(NamedTuple):
-    commit_type: str
-    commits: Sequence[Commit]
-
-
-def render_changelog(
-    organization: str,
-    repository: str,
-    previous_tag: str,
-    current_tag: str,
-    commit_trees: Sequence[CommitTree],
-) -> str:
-    template_loader = FileSystemLoader(searchpath=os.path.dirname(__file__))
-    template_environment = Environment(loader=template_loader)
-    template = template_environment.get_template("changelog_template.jinja")
-
-    return template.render(
-        organization=organization,
-        repository=repository,
-        previous_tag=previous_tag,
-        current_tag=current_tag,
-        commit_trees=commit_trees,
-    )
-
-
-def get_commit_from_type(
-    commits: Sequence[Commit], commit_type: str
-) -> Sequence[Commit]:
-    return sorted(
-        filter(lambda commit: commit.commit_type == commit_type, commits),
-        key=lambda commit: commit.scope,
-    )
-
-
-def get_commit_but_types(
-    commits: Sequence[Commit], commit_types: Sequence[str]
-) -> Sequence[Commit]:
-    return sorted(
-        filter(
-            lambda commit: commit.commit_type
-            and commit.commit_type not in commit_types,
-            commits,
-        ),
-        key=lambda commit: commit.scope,
-    )
+from .generator import generate
 
 
 def main() -> None:
@@ -69,58 +18,23 @@ def main() -> None:
         nargs="*",  # optional list
         help="Filter commits with this semicolon separated git path regex",
     )
+    parser.add_argument(
+        "--target",
+        nargs="?",  # optional argument
+        help="A rev1..rev2 string to be used to generate the commit list",
+    )
     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] = []
-
-    documentations = CommitTree(
-        commit_type=":notebook_with_decorative_cover: Documentation",
-        commits=get_commit_from_type(commits, "docs"),
-    )
-    if documentations.commits:
-        trees.append(documentations)
-
-    features = CommitTree(
-        commit_type=":rocket: Features", commits=get_commit_from_type(commits, "feat")
-    )
-    if features.commits:
-        trees.append(features)
-
-    fixes = CommitTree(
-        commit_type=":bug: Fixes", commits=get_commit_from_type(commits, "fix")
-    )
-    if fixes.commits:
-        trees.append(fixes)
-
-    reverts = CommitTree(
-        commit_type=":scream: Revert", commits=get_commit_from_type(commits, "revert")
-    )
-    if reverts.commits:
-        trees.append(reverts)
-
-    others = CommitTree(
-        commit_type=":nut_and_bolt: Others",
-        commits=get_commit_but_types(
-            commits, ["documentations", "feat", "fix", "revert"]
-        ),
-    )
-    if others.commits:
-        trees.append(others)
 
-    print(
-        render_changelog(
-            organization=repository.organization,
-            repository=repository.name,
-            previous_tag=repository.previous_tag,
-            current_tag=repository.current_tag,
-            commit_trees=trees,
-        )
+    changelog = generate(
+        repository_path="./",
+        prefix=prefix,
+        filter_paths=filter_paths,
+        target=args.target,
     )
+    print(changelog)
 
 
 if __name__ == "__main__":

changelog_generator/generator.py

@@ -0,0 +1,81 @@
+import os
+from typing import List, NamedTuple, Optional, Sequence
+
+from jinja2 import Environment, FileSystemLoader
+
+from .commit import Commit
+from .repository_manager import RepositoryManager
+
+
+class CommitTree(NamedTuple):
+    commit_type: str
+    commits: Sequence[Commit]
+
+
+def render_changelog(
+    organization: str,
+    repository: str,
+    previous_tag: str,
+    current_tag: str,
+    commit_trees: Sequence[CommitTree],
+) -> str:
+    template_loader = FileSystemLoader(searchpath=os.path.dirname(__file__))
+    template_environment = Environment(loader=template_loader)
+    template = template_environment.get_template("changelog_template.jinja")
+
+    return template.render(
+        organization=organization,
+        repository=repository,
+        previous_tag=previous_tag,
+        current_tag=current_tag,
+        commit_trees=commit_trees,
+    )
+
+
+def get_commit_trees(commits: Sequence[Commit]) -> List[CommitTree]:
+    types = {"docs", "feat", "fix", "revert"}
+    titles = {
+        "docs": ":notebook_with_decorative_cover: Documentation",
+        "feat": ":rocket: Features",
+        "fix": ":bug: Fixes",
+        "revert": ":scream: Revert",
+        "others": ":nut_and_bolt: Others",
+    }
+    commit_by_type = {}
+    for commit in commits:
+        if commit.commit_type in types:
+            commit_by_type.setdefault(commit.commit_type, []).append(commit)
+        else:
+            commit_by_type.setdefault("others", []).append(commit)
+
+    return [
+        CommitTree(commit_type=title, commits=commit_by_type[commit_type])
+        for commit_type, title in titles.items()
+        if commit_type in commit_by_type
+    ]
+
+
+def generate(
+    repository_path: str,
+    target: Optional[str] = None,
+    prefix: Optional[str] = None,
+    filter_paths: Optional[str] = None,
+):
+    repository = RepositoryManager(
+        uri=repository_path, prefix=prefix, filter_paths=filter_paths
+    )
+    if target:
+        commits = repository.from_target(target)
+        previous_tag, current_tag = target.split("..")
+    else:
+        commits = repository.commits_since_last_tag
+        previous_tag, current_tag = repository.previous_tag, repository.current_tag
+
+    changelog = render_changelog(
+        organization=repository.organization,
+        repository=repository.name,
+        previous_tag=previous_tag,
+        current_tag=current_tag,
+        commit_trees=get_commit_trees(commits),
+    )
+    return changelog

changelog_generator/repository_manager.py

@@ -60,14 +60,17 @@ def commits_since_last_tag(self) -> Sequence[Commit]:
             revision = f"{self.previous_tag}..{self.current_tag}"
         else:
             revision = self.current_tag
+        return self._get_commits(revision)
 
+    def _get_commits(self, revision: str) -> Sequence[Commit]:
         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 commits
         )
+
+    def from_target(self, target: str) -> Sequence[Commit]:
+        return self._get_commits(target)

changelog_generator/tag_manager.py

@@ -91,6 +91,6 @@ def is_release_tag(self, tag: str) -> bool:
         return res and res.group("prefix") == self.prefix and not res.group("rc")
 
     def get_tags(self):
-        return self.repository.git.tag(f"--merged", "HEAD", f"{self.prefix}/*").split(
-            "\n"
-        )
+        return self.repository.git.tag(
+            "--merged", "origin/master", f"{self.prefix}/*"
+        ).split("\n")

rewrite_all.py

@@ -0,0 +1,58 @@
+from argparse import ArgumentParser
+from collections import deque
+from itertools import islice
+from typing import Iterator, Tuple, TypeVar
+
+from changelog_generator.repository_manager import RepositoryManager
+from rewrite_existing import update_release_note
+
+Item = TypeVar("Item")
+
+
+def sliding_window_iter(it: Iterator[Item], size: int) -> Iterator[Tuple[Item, ...]]:
+    """
+    Get a iterator of sliding sequences
+
+    Examples:
+        it=[1 2 3 4], size=2 -> [(1,2) (2,3) (3,4)]
+    """
+    window = deque(islice(it, size), maxlen=size)
+    for item in it:
+        yield tuple(window)
+        window.append(item)
+    if window:
+        yield tuple(window)
+
+
+def rewrite_all_release_notes_by_prefix():
+    parser = ArgumentParser()
+    parser.add_argument(
+        "repository_path",
+        help="The path to the repository",
+    )
+    parser.add_argument(
+        "prefix",
+        help="The prefix to filter the tags",
+    )
+    parser.add_argument(
+        "filter_paths",
+        nargs="*",
+        help="A space separated list of path to be used to the commits that edited files within "
+        "them",
+    )
+    args = parser.parse_args()
+
+    filter_paths = args.filter_paths
+    path = args.repository_path
+    prefix = args.prefix
+    all_tags_descending = RepositoryManager(
+        path, prefix=prefix, filter_paths=filter_paths
+    ).tags
+
+    for chunk in sliding_window_iter(reversed(all_tags_descending), 2):
+        n, n1 = chunk
+        update_release_note(filter_paths, path, f"{n}..{n1}")
+
+
+if __name__ == "__main__":
+    rewrite_all_release_notes_by_prefix()