Skip to content

git: Sign revup-created commits when commit.gpgSign is set #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jerry-skydio merged 1 commit into from
Jun 26, 2026
Merged

git: Sign revup-created commits when commit.gpgSign is set #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions revup/git.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import re
import shutil
import tempfile
from typing import Any, Dict, List, Optional, Pattern, Tuple
from typing import Any, Dict, List, Optional, Pattern, Tuple, cast

from async_lru import alru_cache as lru_cache

Expand Down Expand Up @@ -151,20 +151,34 @@ async def get_editor() -> str:
ret = os.environ.get("GIT_EDITOR", os.environ.get("EDITOR", "nano"))
return ret

async def get_gpg_sign() -> bool:
# commit-tree (plumbing) ignores commit.gpgSign, so read it and pass -S ourselves.
val = await git_ctx.git_stdout(
"config", "--type=bool", "--get", "commit.gpgSign", raiseonerror=False
)
return val.strip() == "true"

# asyncio.gather is only precisely typed up to 6 awaitables; beyond that
# mypy infers each result as object, so annotate the tuple ourselves.
(
repo_root,
git_dir,
actual_version,
email,
editor,
main_exists,
) = await asyncio.gather(
git_ctx.git_stdout("rev-parse", "--show-toplevel"),
git_ctx.git_stdout("rev-parse", "--path-format=absolute", "--git-dir"),
git_ctx.git_stdout("--version"),
get_email(),
get_editor(),
git_ctx.is_branch_or_commit(f"{remote_name}/{main_branch}"),
gpg_sign,
) = cast(
Tuple[str, str, str, str, str, bool, bool],
await asyncio.gather(
git_ctx.git_stdout("rev-parse", "--show-toplevel"),
git_ctx.git_stdout("rev-parse", "--path-format=absolute", "--git-dir"),
git_ctx.git_stdout("--version"),
get_email(),
get_editor(),
git_ctx.is_branch_or_commit(f"{remote_name}/{main_branch}"),
get_gpg_sign(),
),
)

if git_version:
Expand All @@ -184,6 +198,7 @@ async def get_editor() -> str:
git_ctx.email = email.lower()
git_ctx.author = git_ctx.email.split("@")[0]
git_ctx.editor = editor
git_ctx.gpg_sign = gpg_sign
if not main_exists:
if main_branch in COMMON_MAIN_BRANCHES:
git_ctx.main_branch = COMMON_MAIN_BRANCHES[1 - COMMON_MAIN_BRANCHES.index(main_branch)]
Expand Down Expand Up @@ -225,6 +240,9 @@ class Git:
author: str
editor: str

# Whether to GPG/SSH sign commits revup creates, from git config commit.gpgSign
gpg_sign: bool

def __init__(
self,
sh: shell.Shell,
Expand All @@ -239,6 +257,7 @@ def __init__(
self.remote_name = remote_name
self.keep_temp = keep_temp
self.main_branch = main_branch
self.gpg_sign = False
self.base_branch_globs = base_branch_globs.strip().splitlines()
self.temp_dir = tempfile.TemporaryDirectory( # pylint: disable=consider-using-with
prefix="revup_"
Expand Down Expand Up @@ -556,6 +575,8 @@ async def commit_tree(self, commit_info: CommitHeader) -> GitCommitHash:
"-m",
commit_info.commit_msg,
]
if self.gpg_sign:
commit_tree_args.append("-S")
for p in commit_info.parents:
commit_tree_args.extend(["-p", p])
ret = await self.git_stdout(*commit_tree_args, env=git_env)
Expand Down
Loading