-
-
Notifications
You must be signed in to change notification settings - Fork 8
Add opt-in GPG-signed commits via GitHub API #53
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.
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
Open
dragid10
wants to merge
1
commit into
sanitizers:master
Choose a base branch
from
dragid10:feat/gpg-signed-commits
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| """GitHub Git Data REST API wrapper for signed commit creation.""" | ||
|
|
||
| import http.client | ||
| import logging | ||
|
|
||
| from gidgethub import BadRequest | ||
|
|
||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def _handle_bad_request(bad_req_err: BadRequest) -> None: | ||
| """Re-raise as ``PermissionError`` if the request was denied.""" | ||
| if ( | ||
| bad_req_err.status_code != http.client.FORBIDDEN or | ||
| str(bad_req_err) != 'Resource not accessible by integration' | ||
| ): | ||
| raise | ||
|
|
||
| raise PermissionError(str(bad_req_err)) from bad_req_err | ||
|
|
||
|
|
||
| class GitAPI: | ||
| """Git Data API for creating signed commits and branch refs.""" | ||
|
|
||
| def __init__(self, *, api, repo_slug: str) -> None: | ||
| """Initialize a GitAPI instance for a given repo.""" | ||
| self._api = api | ||
| self._repo_slug = repo_slug | ||
|
|
||
| async def get_branch_head_sha(self, branch_name: str) -> str: | ||
| """Return the HEAD commit SHA of a branch.""" | ||
| try: | ||
| ref = await self._api.getitem( | ||
| f'/repos/{self._repo_slug}/git/ref/heads/{branch_name}', | ||
| ) | ||
| except BadRequest as bad_req_err: | ||
| _handle_bad_request(bad_req_err) | ||
| return ref['object']['sha'] | ||
|
|
||
| async def create_commit( | ||
| self, *, tree_sha: str, message: str, parent_sha: str, | ||
| ) -> str: | ||
| """Create a commit and return its SHA. | ||
|
|
||
| Commits created through the Git Data API are automatically | ||
| signed by GitHub's web-flow GPG key. | ||
| """ | ||
| try: | ||
| resp = await self._api.post( | ||
| f'/repos/{self._repo_slug}/git/commits', | ||
| data={ | ||
| 'message': message, | ||
| 'tree': tree_sha, | ||
| 'parents': [parent_sha], | ||
| }, | ||
| ) | ||
| except BadRequest as bad_req_err: | ||
| _handle_bad_request(bad_req_err) | ||
| return resp['sha'] | ||
|
|
||
| async def create_branch( | ||
| self, *, branch_name: str, sha: str, | ||
| ) -> None: | ||
| """Create a branch ref pointing to the given commit SHA.""" | ||
| try: | ||
| await self._api.post( | ||
| f'/repos/{self._repo_slug}/git/refs', | ||
| data={ | ||
| 'ref': f'refs/heads/{branch_name}', | ||
| 'sha': sha, | ||
| }, | ||
| ) | ||
| except BadRequest as bad_req_err: | ||
| _handle_bad_request(bad_req_err) | ||
|
|
||
| async def create_signed_branch( | ||
| self, *, | ||
| tree_sha: str, | ||
| message: str, | ||
| parent_branch: str, | ||
| branch_name: str, | ||
| ) -> str: | ||
| """Create a signed commit on a new branch. | ||
|
|
||
| Fetches the parent branch HEAD, creates a signed commit from | ||
| the given tree, and points a new branch at it. Returns the | ||
| signed commit SHA. | ||
| """ | ||
| parent_sha = await self.get_branch_head_sha(parent_branch) | ||
| commit_sha = await self.create_commit( | ||
| tree_sha=tree_sha, | ||
| message=message, | ||
| parent_sha=parent_sha, | ||
| ) | ||
| logger.info('Created signed commit `%s`', commit_sha) | ||
| await self.create_branch(branch_name=branch_name, sha=commit_sha) | ||
| logger.info('Created branch `%s`', branch_name) | ||
| return commit_sha | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this actually work? What if it's called outside of the exception handling context? Seems rather fragile.