Add support for workflow run pending deployments#3538
Open
r1cksync wants to merge 1 commit into
Open
Conversation
Add WorkflowRun.get_pending_deployments() and WorkflowRun.review_pending_deployments() to support the GitHub Actions deployment-protection-rules API, along with a new PendingDeployment class and replay-based tests.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This adds support for the GitHub Actions deployment protection rules API on
WorkflowRun, which was previously not exposed by PyGithub.What's added
WorkflowRun.get_pending_deployments()—GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments. Returns the list of deployments for a run that are waiting on environment protection rules, asPendingDeploymentobjects.WorkflowRun.review_pending_deployments(environment_ids, state, comment="")—POST .../pending_deployments. Approves or rejects pending deployments for the given environments and returns the resultingDeploymentobjects.PendingDeploymentclass (NonCompletableGithubObject) exposingenvironment,wait_timer,wait_timer_started_at,current_user_can_approveandreviewers.Tests
Two replay-based tests (
testGetPendingDeployments,testReviewPendingDeployments) with hand-crafted fixtures cover both the GET and the POST paths, including reviewer parsing (User and Team) and the returned deployment objects. The fulltests/WorkflowRun.pysuite passes, and the changes are clean underblack,ruff,isort,docformatterandcodespell.References