wip

github/actions_workflow_runs.go

@@ -412,7 +412,7 @@ func (s *ActionsService) GetWorkflowRunUsageByID(ctx context.Context, owner, rep
 	return workflowRunUsage, resp, nil
 }
 
-// GetPendingDeployments Get all deployment environments for a workflow run that are waiting for protection rules to pass.
+// GetPendingDeployments get all deployment environments for a workflow run that are waiting for protection rules to pass.
 //
 // GitHub API docs: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
 //
@@ -457,6 +457,7 @@ func (s *ActionsService) PendingDeployments(ctx context.Context, owner, repo str
 }
 
 // ReviewCustomDeploymentProtectionRule approve or reject custom deployment protection rules provided by a GitHub App for a workflow run
+//
 // GitHub API docs: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
 //
 //meta:operation POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule

github/event_types.go

@@ -230,16 +230,19 @@ type DeploymentProtectionRuleEvent struct {
 //
 // GitHub API docs: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads?#deployment_review
 type DeploymentReviewEvent struct {
-	Action *string `json:"action,omitempty"`
-	// FIXME omitされる場合を考えると、並び順は変えたほうがよいかもしれない
-	Approver        *User               `json:"approver,omitempty"`
-	Environment     *string             `json:"environment,omitempty"`
-	Comment         *string             `json:"comment,omitempty"`
+	Action  *string `json:"action,omitempty"`
+	Comment *string `json:"comment,omitempty"`
+	// requester only populated when requested.
+	Requester *User `json:"requester,omitempty"`
+	// approver only populated when approved or rejected.
+	Approver *User `json:"approver,omitempty"`
+
+	Environment *string `json:"environment,omitempty"`
+
 	Enterprise      *Enterprise         `json:"enterprise,omitempty"`
 	Installation    *Installation       `json:"installation,omitempty"`
 	Organization    *Organization       `json:"organization,omitempty"`
 	Repo            *Repository         `json:"repository,omitempty"`
-	Requester       *User               `json:"requester,omitempty"`
 	Reviewers       []*RequiredReviewer `json:"reviewers,omitempty"`
 	Sender          *User               `json:"sender,omitempty"`
 	Since           *string             `json:"since,omitempty"`

github/event_types_test.go

@@ -6392,7 +6392,15 @@ func TestDeploymentProtectionRuleEvent_Marshal(t *testing.T) {
 }
 
 func TestDeploymentReviewEvent_Marshal(t *testing.T) {
-	testJSONMarshal(t, &DeploymentReviewEvent{}, "FIXME")
+	testJSONMarshal(t, &DeploymentReviewEvent{}, "{}")
+
+	u := &DeploymentReviewEvent{}
+
+	want := `{
+		"fix": "me"
+	}`
+
+	testJSONMarshal(t, u, want)
 }
 
 func TestDeploymentStatusEvent_Marshal(t *testing.T) {