Skip PR with skip changelog (#33)

* Skip PR with skip changelog

* Pop skip

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add group config to test

* Correct type hint for group config

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

antsichaut/antsichaut.py

@@ -6,7 +6,7 @@
 from functools import cached_property
 from importlib.metadata import version as _version
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any, Optional, Sequence
 
 import configargparse
 import requests
@@ -39,7 +39,7 @@ def __init__(  # noqa: PLR0913
         repository: str,
         since_version: str,
         to_version: str,
-        group_config: list[dict[str, str]],
+        group_config: list[dict[str, Sequence[str]]],
         filename: str = "changelogs/changelog.yaml",
         token: Optional[str] = None,
     ) -> None:
@@ -257,14 +257,19 @@ def parse_changelog(  # noqa: C901, PLR0912
         )
 
         leftover_changes = []
+
+        skip_labels = self.group_config.pop(
+            [i for i, d in enumerate(self.group_config) if d["title"] == "skip_changelog"][0],
+        )["labels"]
+
         for pull_request in changes:
+            # if a PR contains a skip changelog label, ignore it entirely
+            # do not add it to the changelog
+            if any(label in pull_request["labels"] for label in skip_labels):
+                break
+
             for config in self.group_config:
                 if any(label in pull_request["labels"] for label in config["labels"]):
-                    # if a PR contains a skip changelog label,
-                    # do not add it to the changelog
-                    if config["title"] in ["skip_changelog", "skip-changelog", "skipchangelog"]:
-                        break
-
                     change_type = config["title"]
 
                     # add the new change section if it does not exist yet
@@ -473,7 +478,10 @@ def main() -> None:
         dest="skip_changelog_labels",
         type=str,
         action="append",
-        help="the labels for skip_changelog. Default: ['skip_changelog']",
+        help=(
+            "the labels for skip_changelog. "
+            "Default: ['skip_changelog', 'skip-changelog', 'skipchangelog']"
+        ),
         env_var="SKIP_CHANGELOG_LABELS",
         required=False,
     )
@@ -500,7 +508,7 @@ def main() -> None:
     if not args.bugfixes_labels:
         args.bugfixes_labels = ["bug", "bugfix"]
     if not args.skip_changelog_labels:
-        args.skip_changelog_labels = ["skip_changelog"]
+        args.skip_changelog_labels = ["skip_changelog", "skip-changelog", "skipchangelog"]
 
     repository = args.repository
     since_version = args.since_version

tests/test_basic.py

@@ -18,6 +18,12 @@
 
 REPO = "ansible-community/antsichaut"
 FIXTURE_DIR = Path(__file__).parent / "fixtures"
+GROUP_CONFIG = [
+    {
+        "title": "skip_changelog",
+        "labels": ["skip_changelog", "skip-changelog", "skipchangelog"],
+    },
+]
 
 
 def test_failure(capsys: pytest.CaptureFixture[str]) -> None:
@@ -29,7 +35,7 @@ def test_failure(capsys: pytest.CaptureFixture[str]) -> None:
         repository=REPO,
         since_version="0.0.0",
         to_version="",
-        group_config=[],
+        group_config=GROUP_CONFIG,
     )
     cci.run()
     captured = capsys.readouterr()
@@ -86,7 +92,7 @@ def _write_changelog(self) -> None:
         repository=REPO,
         since_version="0.3.2",
         to_version="0.3.5",
-        group_config=[],
+        group_config=GROUP_CONFIG,
         token=token,
     )
     cci.run()