[feat]: [CDS-75848]: Add new action type for github provider

[rathodmeetsatish]

No description provided.

[CLAassistant]

All committers have signed the CLA.

[tphoney]

The code implementation looks good and it has unit tests as well.
My issue would be, do other SCM providers have this concept ?
The whole point of go-scm is to abstract away implementation details from each SCM to give a generic way of dealing with SCM systems as a whole.
If this is only a github only feature, it does not make sense to add this as a new actiontype.

So can you look to see if this concept of pr approval exists in the other supported SCM webhooks. eg gitlab / gogs / bitbucket

[bradrydzewski]

I agree with TP. When adding new functionality to this library it is standard practice to provide implementations for more than one provider to ensure we have the correct abstractions in place. I recommend adding GitLab or Bitbucket to this pull request.

EDIT

It looks like other providers don't have this action type. However, with that being said, we could emulate this event for GitLab by looking at the changes section of the webhook to see if the draft field changed from true to false.

Example GitLab webhook.

  "changes": {
    "draft": {
      "previous": true,
      "current": false
    },
    "title": {
      "previous": "Draft: Update README.md",
      "current": "Update README.md"
    },
    "updated_at": {
      "previous": "2023-08-31 18:03:37 UTC",
      "current": "2023-08-31 18:04:01 UTC"
    },
    "updated_by_id": {
      "previous": null,
      "current": 8881996
    }
  }

Example change to GitLab driver:

func convertPullRequestHook(src *pullRequestHook) *scm.PullRequestHook {
	action := scm.ActionSync
	switch src.ObjectAttributes.Action {
	case "open":
		action = scm.ActionOpen
	case "close":
		action = scm.ActionClose
	case "reopen":
		action = scm.ActionReopen
	case "merge":
		action = scm.ActionMerge
	case "update":
		action = scm.ActionSync
+		// emulate the ready_for_review event by inspecting
+		// the change in draft status from true to false
+		if src.Changes.Draft.Previous.Bool == true {
+			action = scm.ReadyForReview
+		}
	}

		Changes struct {
+			Draft struct {
+					Previous null.Bool `json:"previous"
+					Current  null.Bool `json:"current"
+			} `json:"draft"`
			Labels struct {
				Previous []interface{} `json:"previous"`
				Current  []struct {
					ID          int         `json:"id"`
					Title       string      `json:"title"`
					Color       string      `json:"color"`
					ProjectID   int         `json:"project_id"`
					CreatedAt   string      `json:"created_at"`
					UpdatedAt   string      `json:"updated_at"`
					Template    bool        `json:"template"`
					Description string      `json:"description"`
					Type        string      `json:"type"`
					GroupID     interface{} `json:"group_id"`
				} `json:"current"`
			} `json:"labels"`
		} `json:"changes"`

I would also rename to review_ready so that we use review_ as the prefix. This will ensure consistency if we ever add other review_ actions in the future, such as review_request_add or review_request_remove

// Action values.
const (
	ActionUnknown Action = iota
	ActionCreate
	ActionUpdate
	ActionDelete
	// issues
	ActionOpen
	ActionReopen
	ActionClose
	ActionLabel
	ActionUnlabel
	// pull requests
	ActionSync
	ActionMerge
-	ActionReadyForReview
+	ActionReviewReady
	// issue comment
	ActionEdit
	// release
	ActionPublish
	ActionUnpublish
	ActionPrerelease
	ActionRelease
)