Add: Allow to load changelog from file when creating a release

Allow to load a pre-created changelog file when creating a new release
instead of gathering the changelog from the git commits. This allows to
use different tools then pontos for changelog creation and also reduces
required mocking in the create release command tests.

Author: bjoernricks

pontos/release/_parser.py

@@ -33,9 +33,7 @@
 DEFAULT_SIGNING_KEY = "0ED1E580"
 
 
-class ReleaseVersionAction(
-    argparse._StoreAction
-):  # pylint: disable=protected-access
+class ReleaseVersionAction(argparse._StoreAction):
     def __call__(self, parser, namespace, values, option_string=None):
         setattr(namespace, "release_type", ReleaseType.VERSION)
         setattr(namespace, self.dest, values)
@@ -144,13 +142,6 @@ def add_create_parser(
         help="Only create release changes locally and do not upload them to a "
         "remote repository. Also do not create a GitHub release.",
     )
-    create_parser.add_argument(
-        "--conventional-commits-config",
-        dest="cc_config",
-        type=Path,
-        help="Conventional commits config file (toml), including conventions."
-        " If not set defaults are used.",
-    )
     create_parser.add_argument(
         "--update-project",
         help="Update version in project files like pyproject.toml. By default "
@@ -163,6 +154,19 @@ def add_create_parser(
         help="Enforce uploading a release as GitHub pre-release. ",
         action="store_true",
     )
+    changelog_parser = create_parser.add_mutually_exclusive_group()
+    changelog_parser.add_argument(
+        "--conventional-commits-config",
+        dest="cc_config",
+        type=Path,
+        help="Conventional commits config file (toml), including conventions."
+        " If not set defaults are used.",
+    )
+    changelog_parser.add_argument(
+        "--changelog",
+        type=Path,
+        help="Read the release notes from the given file.",
+    )
 
 
 def add_sign_parser(

pontos/release/create.py

@@ -180,6 +180,7 @@ async def async_run(  # type: ignore[override]
         release_series: Optional[str] = None,
         update_project: bool = True,
         github_pre_release: bool = False,
+        changelog: Optional[str] = None,
     ) -> CreateReleaseReturnValue:
         """
         Create a release
@@ -214,6 +215,8 @@ async def async_run(  # type: ignore[override]
             update_project: Update version in project files.
             github_pre_release: Enforce uploading a release as a GitHub pre
                 release
+            changelog: An optional changelog. If not set a changelog will be
+                gathered from the git commits since the last release.
         """
         self.git_tag_prefix = git_tag_prefix or ""
         self.repository = repository
@@ -300,9 +303,12 @@ async def async_run(  # type: ignore[override]
                 f"Creating changelog for {release_version} as initial release."
             )
 
-        release_text = self._create_changelog(
-            release_version, last_release_version, cc_config
-        )
+        if changelog:
+            release_text = changelog
+        else:
+            release_text = self._create_changelog(
+                release_version, last_release_version, cc_config
+            )
 
         commit_msg = f"Automatic release to {release_version}"
 
@@ -416,6 +422,10 @@ def create_release(
         )
         return CreateReleaseReturnValue.TOKEN_MISSING
 
+    changelog_file: Path = args.changelog
+    if changelog_file and not changelog_file.exists():
+        error_terminal.error(f"Changelog file {changelog_file} does not exist.")
+        return CreateReleaseReturnValue.CREATE_RELEASE_ERROR
     return CreateReleaseCommand(
         terminal=terminal, error_terminal=error_terminal
     ).run(
@@ -434,4 +444,5 @@ def create_release(
         release_series=args.release_series,
         update_project=args.update_project,
         github_pre_release=args.github_pre_release,
+        changelog=changelog_file.read_text() if changelog_file else None,
     )