fix(cmd-version): forces tag timestamp to be same time as release commit (python-semantic-release#1117)

codejedi365 · web-flow · commit 7898b1185fc1 · 2024-12-08T18:27:19.000-07:00
diff --git a/src/semantic_release/cli/commands/version.py b/src/semantic_release/cli/commands/version.py
@@ -653,6 +653,7 @@ def version(  # noqa: C901
         project.git_tag(
             tag_name=new_version.as_tag(),
             message=new_version.as_tag(),
+            isotimestamp=commit_date.isoformat(),
             noop=opts.noop,
         )
 
diff --git a/src/semantic_release/gitproject.py b/src/semantic_release/gitproject.py
@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from contextlib import nullcontext
+from datetime import datetime
 from logging import getLogger
 from pathlib import Path
 from typing import TYPE_CHECKING
@@ -48,23 +49,36 @@ def logger(self) -> Logger:
         return self._logger
 
     def _get_custom_environment(
-        self, repo: Repo
+        self,
+        repo: Repo,
+        custom_vars: dict[str, str] | None = None,
     ) -> nullcontext[None] | _GeneratorContextManager[None]:
         """
         git.custom_environment is a context manager but
         is not reentrant, so once we have "used" it
         we need to throw it away and re-create it in
         order to use it again
         """
+        author_vars = (
+            {
+                "GIT_AUTHOR_NAME": self._commit_author.name,
+                "GIT_AUTHOR_EMAIL": self._commit_author.email,
+                "GIT_COMMITTER_NAME": self._commit_author.name,
+                "GIT_COMMITTER_EMAIL": self._commit_author.email,
+            }
+            if self._commit_author
+            else {}
+        )
+
+        custom_env_vars = {
+            **author_vars,
+            **(custom_vars or {}),
+        }
+
         return (
             nullcontext()
-            if not self._commit_author
-            else repo.git.custom_environment(
-                GIT_AUTHOR_NAME=self._commit_author.name,
-                GIT_AUTHOR_EMAIL=self._commit_author.email,
-                GIT_COMMITTER_NAME=self._commit_author.name,
-                GIT_COMMITTER_EMAIL=self._commit_author.email,
-            )
+            if not custom_env_vars
+            else repo.git.custom_environment(**custom_env_vars)
         )
 
     def is_dirty(self) -> bool:
@@ -182,19 +196,32 @@ def git_commit(
                     self.logger.exception(str(err))
                     raise GitCommitError("Failed to commit changes") from err
 
-    def git_tag(self, tag_name: str, message: str, noop: bool = False) -> None:
+    def git_tag(
+        self, tag_name: str, message: str, isotimestamp: str, noop: bool = False
+    ) -> None:
+        try:
+            datetime.fromisoformat(isotimestamp)
+        except ValueError as err:
+            raise ValueError("Invalid timestamp format") from err
+
         if noop:
-            command = (
-                f"""\
-                GIT_AUTHOR_NAME={self._commit_author.name} \\
-                GIT_AUTHOR_EMAIL={self._commit_author.email} \\
-                GIT_COMMITTER_NAME={self._commit_author.name} \\
-                GIT_COMMITTER_EMAIL={self._commit_author.email} \\
-                """
-                if self._commit_author
-                else ""
+            command = str.join(
+                " ",
+                [
+                    f"GIT_COMMITTER_DATE={isotimestamp}",
+                    *(
+                        [
+                            f"GIT_AUTHOR_NAME={self._commit_author.name}",
+                            f"GIT_AUTHOR_EMAIL={self._commit_author.email}",
+                            f"GIT_COMMITTER_NAME={self._commit_author.name}",
+                            f"GIT_COMMITTER_EMAIL={self._commit_author.email}",
+                        ]
+                        if self._commit_author
+                        else [""]
+                    ),
+                    f"git tag -a {tag_name} -m '{message}'",
+                ],
             )
-            command += f"git tag -a {tag_name} -m '{message}'"
 
             noop_report(
                 indented(
@@ -206,7 +233,10 @@ def git_tag(self, tag_name: str, message: str, noop: bool = False) -> None:
             )
             return
 
-        with Repo(str(self.project_root)) as repo, self._get_custom_environment(repo):
+        with Repo(str(self.project_root)) as repo, self._get_custom_environment(
+            repo,
+            {"GIT_COMMITTER_DATE": isotimestamp},
+        ):
             try:
                 repo.git.tag("-a", tag_name, m=message)
             except GitCommandError as err:

Original file line number	Diff line number	Diff line change
`@@ -653,6 +653,7 @@ def version( # noqa: C901`
`653`	`653`	`project.git_tag(`
`654`	`654`	`tag_name=new_version.as_tag(),`
`655`	`655`	`message=new_version.as_tag(),`
	`656`	`+ isotimestamp=commit_date.isoformat(),`
`656`	`657`	`noop=opts.noop,`
`657`	`658`	`)`
`658`	`659`