Fix `ref` for workflows triggered by `pull_request_target` (#25743)

Follow #25229

At present, when the trigger event is `pull_request_target`, the `ref`
and `sha` of `ActionRun` are set according to the base branch of the
pull request. This makes it impossible for us to find the head branch of
the `ActionRun` directly. In this PR, the `ref` and `sha` will always be
set to the head branch and they will be changed to the base branch when
generating the task context.

diff --git a/modules/actions/workflows.go b/modules/actions/workflows.go
index c4fc60e07097c562e657c0f71d21a62944792cdb..2c7cec5591de33115c797494c34a97e5a871be68 100644 (file)
--- a/modules/actions/workflows.go
+++ b/modules/actions/workflows.go
@@ -23,8 +23,6 @@ import (
 type DetectedWorkflow struct {
        EntryName    string
        TriggerEvent string
-       Commit       *git.Commit
-       Ref          string
        Content      []byte
 }
 
@@ -120,7 +118,6 @@ func DetectWorkflows(commit *git.Commit, triggedEvent webhook_module.HookEventTy
                                dwf := &DetectedWorkflow{
                                        EntryName:    entry.Name(),
                                        TriggerEvent: evt.Name,
-                                       Commit:       commit,
                                        Content:      content,
                                }
                                workflows = append(workflows, dwf)

diff --git a/routers/api/actions/runner/utils.go b/routers/api/actions/runner/utils.go
index 834a8c44000c71f4a59ee12c0cb501230990e0c3..e95df7a00fa809fe23209b2cbc33cdf50f32189c 100644 (file)
--- a/routers/api/actions/runner/utils.go
+++ b/routers/api/actions/runner/utils.go
@@ -129,12 +129,22 @@ func generateTaskContext(t *actions_model.ActionTask) *structpb.Struct {
 
        baseRef := ""
        headRef := ""
+       ref := t.Job.Run.Ref
+       sha := t.Job.Run.CommitSHA
        if pullPayload, err := t.Job.Run.GetPullRequestEventPayload(); err == nil && pullPayload.PullRequest != nil && pullPayload.PullRequest.Base != nil && pullPayload.PullRequest.Head != nil {
                baseRef = pullPayload.PullRequest.Base.Ref
                headRef = pullPayload.PullRequest.Head.Ref
+
+               // if the TriggerEvent is pull_request_target, ref and sha need to be set according to the base of pull request
+               // In GitHub's documentation, ref should be the branch or tag that triggered workflow. But when the TriggerEvent is pull_request_target,
+               // the ref will be the base branch.
+               if t.Job.Run.TriggerEvent == actions_module.GithubEventPullRequestTarget {
+                       ref = git.BranchPrefix + pullPayload.PullRequest.Base.Name
+                       sha = pullPayload.PullRequest.Base.Sha
+               }
        }
 
-       refName := git.RefName(t.Job.Run.Ref)
+       refName := git.RefName(ref)
 
        taskContext, err := structpb.NewStruct(map[string]any{
                // standard contexts, see https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
@@ -153,7 +163,7 @@ func generateTaskContext(t *actions_model.ActionTask) *structpb.Struct {
                "graphql_url":       "",                                                   // string, The URL of the GitHub GraphQL API.
                "head_ref":          headRef,                                              // string, The head_ref or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either pull_request or pull_request_target.
                "job":               fmt.Sprint(t.JobID),                                  // string, The job_id of the current job.
-               "ref":               t.Job.Run.Ref,                                        // string, The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by push, this is the branch or tag ref that was pushed. For workflows triggered by pull_request, this is the pull request merge branch. For workflows triggered by release, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is refs/heads/<branch_name>, for pull requests it is refs/pull/<pr_number>/merge, and for tags it is refs/tags/<tag_name>. For example, refs/heads/feature-branch-1.
+               "ref":               ref,                                                  // string, The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by push, this is the branch or tag ref that was pushed. For workflows triggered by pull_request, this is the pull request merge branch. For workflows triggered by release, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is refs/heads/<branch_name>, for pull requests it is refs/pull/<pr_number>/merge, and for tags it is refs/tags/<tag_name>. For example, refs/heads/feature-branch-1.
                "ref_name":          refName.ShortName(),                                  // string, The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on GitHub. For example, feature-branch-1.
                "ref_protected":     false,                                                // boolean, true if branch protections are configured for the ref that triggered the workflow run.
                "ref_type":          refName.RefType(),                                    // string, The type of ref that triggered the workflow run. Valid values are branch or tag.
@@ -167,7 +177,7 @@ func generateTaskContext(t *actions_model.ActionTask) *structpb.Struct {
                "run_attempt":       fmt.Sprint(t.Job.Attempt),                            // string, A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run.
                "secret_source":     "Actions",                                            // string, The source of a secret used in a workflow. Possible values are None, Actions, Dependabot, or Codespaces.
                "server_url":        setting.AppURL,                                       // string, The URL of the GitHub server. For example: https://github.com.
-               "sha":               t.Job.Run.CommitSHA,                                  // string, The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see "Events that trigger workflows." For example, ffac537e6cbbf934b08745a378932722df287a53.
+               "sha":               sha,                                                  // string, The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see "Events that trigger workflows." For example, ffac537e6cbbf934b08745a378932722df287a53.
                "token":             t.Token,                                              // string, A token to authenticate on behalf of the GitHub App installed on your repository. This is functionally equivalent to the GITHUB_TOKEN secret. For more information, see "Automatic token authentication."
                "triggering_actor":  "",                                                   // string, The username of the user that initiated the workflow run. If the workflow run is a re-run, this value may differ from github.actor. Any workflow re-runs will use the privileges of github.actor, even if the actor initiating the re-run (github.triggering_actor) has different privileges.
                "workflow":          t.Job.Run.WorkflowID,                                 // string, The name of the workflow. If the workflow file doesn't specify a name, the value of this property is the full path of the workflow file in the repository.

diff --git a/services/actions/notifier_helper.go b/services/actions/notifier_helper.go
index 8e6cdcf680d1b85b7fd88cf6ec9b530b47c98dfa..c4c2a0df29b748c745845eabe2a875e9c81c3ac6 100644 (file)
--- a/services/actions/notifier_helper.go
+++ b/services/actions/notifier_helper.go
@@ -152,7 +152,6 @@ func notify(ctx context.Context, input *notifyInput) error {
        } else {
                for _, wf := range workflows {
                        if wf.TriggerEvent != actions_module.GithubEventPullRequestTarget {
-                               wf.Ref = ref
                                detectedWorkflows = append(detectedWorkflows, wf)
                        }
                }
@@ -174,7 +173,6 @@ func notify(ctx context.Context, input *notifyInput) error {
                } else {
                        for _, wf := range baseWorkflows {
                                if wf.TriggerEvent == actions_module.GithubEventPullRequestTarget {
-                                       wf.Ref = baseRef
                                        detectedWorkflows = append(detectedWorkflows, wf)
                                }
                        }
@@ -212,8 +210,8 @@ func notify(ctx context.Context, input *notifyInput) error {
                        OwnerID:           input.Repo.OwnerID,
                        WorkflowID:        dwf.EntryName,
                        TriggerUserID:     input.Doer.ID,
-                       Ref:               dwf.Ref,
-                       CommitSHA:         dwf.Commit.ID.String(),
+                       Ref:               ref,
+                       CommitSHA:         commit.ID.String(),
                        IsForkPullRequest: isForkPullRequest,
                        Event:             input.Event,
                        EventPayload:      string(p),

diff --git a/tests/integration/actions_trigger_test.go b/tests/integration/actions_trigger_test.go
index bbf7ad302e08f85348c3711ba9600ed60b02cb19..bacf13e6c56acdea7ac9ae65b1e184caa5da5281 100644 (file)
--- a/tests/integration/actions_trigger_test.go
+++ b/tests/integration/actions_trigger_test.go
@@ -138,7 +138,7 @@ func TestPullRequestTargetEvent(t *testing.T) {
 
                // load and compare ActionRun
                actionRun := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{RepoID: baseRepo.ID})
-               assert.Equal(t, addWorkflowToBaseResp.Commit.SHA, actionRun.CommitSHA)
+               assert.Equal(t, addFileToForkedResp.Commit.SHA, actionRun.CommitSHA)
                assert.Equal(t, actions_module.GithubEventPullRequestTarget, actionRun.TriggerEvent)
        })
 }