Rename notifier to WorkflowJobStatusUpdate

ChristopherHX · ChristopherHX · commit 618f044d4eec · 2025-02-25T12:27:57.000+01:00
* add URL field
* add HTMLURL field
* fix run_url to return api url instead of html url
diff --git a/modules/structs/repo_actions.go b/modules/structs/repo_actions.go
@@ -112,6 +112,8 @@ type ActionWorkflowStep struct {
 // ActionWorkflowJob represents a WorkflowJob
 type ActionWorkflowJob struct {
 	ID         int64                 `json:"id"`
+	URL        string                `json:"url"`
+	HtmlURL    string                `json:"html_url"`
 	RunID      int64                 `json:"run_id"`
 	RunURL     string                `json:"run_url"`
 	Name       string                `json:"name"`
diff --git a/routers/api/actions/runner/runner.go b/routers/api/actions/runner/runner.go
@@ -221,7 +221,7 @@ func (s *Service) UpdateTask(
 	}
 
 	if task.Status.IsDone() {
-		notifier.CreateWorkflowJob(ctx, task.Job.Run.Repo, task.Job.Run.TriggerUser, task.Job, task)
+		notifier.WorkflowJobStatusUpdate(ctx, task.Job.Run.Repo, task.Job.Run.TriggerUser, task.Job, task)
 	}
 
 	if req.Msg.State.Result != runnerv1.Result_RESULT_UNSPECIFIED {
diff --git a/routers/web/repo/actions/view.go b/routers/web/repo/actions/view.go
@@ -460,7 +460,7 @@ func rerunJob(ctx *context_module.Context, job *actions_model.ActionRunJob, shou
 
 	actions_service.CreateCommitStatus(ctx, job)
 	_ = job.LoadAttributes(ctx)
-	notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
+	notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
 
 	return nil
 }
@@ -559,7 +559,7 @@ func Cancel(ctx *context_module.Context) {
 
 	for _, job := range updatedjobs {
 		_ = job.LoadAttributes(ctx)
-		notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
+		notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
 	}
 
 	ctx.JSON(http.StatusOK, struct{}{})
@@ -605,7 +605,7 @@ func Approve(ctx *context_module.Context) {
 
 	for _, job := range updatedjobs {
 		_ = job.LoadAttributes(ctx)
-		notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
+		notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
 	}
 
 	ctx.JSON(http.StatusOK, struct{}{})
diff --git a/services/actions/clear_tasks.go b/services/actions/clear_tasks.go
@@ -71,7 +71,7 @@ func stopTasks(ctx context.Context, opts actions_model.FindTaskOptions) error {
 	CreateCommitStatus(ctx, jobs...)
 	for _, job := range jobs {
 		_ = job.LoadAttributes(ctx)
-		notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
+		notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
 	}
 	return nil
 }
@@ -103,7 +103,7 @@ func CancelAbandonedJobs(ctx context.Context) error {
 		CreateCommitStatus(ctx, job)
 		if updated {
 			_ = job.LoadAttributes(ctx)
-			notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
+			notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
 		}
 	}
 
diff --git a/services/actions/job_emitter.go b/services/actions/job_emitter.go
@@ -76,7 +76,7 @@ func checkJobsOfRun(ctx context.Context, runID int64) error {
 	CreateCommitStatus(ctx, jobs...)
 	for _, job := range updatedjobs {
 		_ = job.LoadAttributes(ctx)
-		notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
+		notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)
 	}
 	return nil
 }
diff --git a/services/actions/notifier_helper.go b/services/actions/notifier_helper.go
@@ -365,7 +365,7 @@ func handleWorkflows(
 		}
 		CreateCommitStatus(ctx, alljobs...)
 		for _, job := range alljobs {
-			notifier.CreateWorkflowJob(ctx, input.Repo, input.Doer, job, nil)
+			notifier.WorkflowJobStatusUpdate(ctx, input.Repo, input.Doer, job, nil)
 		}
 	}
 	return nil
diff --git a/services/actions/schedule_tasks.go b/services/actions/schedule_tasks.go
@@ -158,7 +158,7 @@ func CreateScheduleTask(ctx context.Context, cron *actions_model.ActionSchedule)
 		log.Error("LoadAttributes: %v", err)
 	}
 	for _, job := range allJobs {
-		notifier.CreateWorkflowJob(ctx, run.Repo, run.TriggerUser, job, nil)
+		notifier.WorkflowJobStatusUpdate(ctx, run.Repo, run.TriggerUser, job, nil)
 	}
 
 	// Return nil if no errors occurred
diff --git a/services/actions/task.go b/services/actions/task.go
@@ -77,7 +77,7 @@ func PickTask(ctx context.Context, runner *actions_model.ActionRunner) (*runnerv
 	}
 
 	CreateCommitStatus(ctx, job)
-	notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, actionTask)
+	notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, actionTask)
 
 	return task, true, nil
 }
diff --git a/services/actions/workflow.go b/services/actions/workflow.go
@@ -278,7 +278,7 @@ func DispatchActionWorkflow(ctx reqctx.RequestContext, doer *user_model.User, re
 	}
 	CreateCommitStatus(ctx, allJobs...)
 	for _, job := range allJobs {
-		notifier.CreateWorkflowJob(ctx, repo, doer, job, nil)
+		notifier.WorkflowJobStatusUpdate(ctx, repo, doer, job, nil)
 	}
 
 	return nil
diff --git a/services/notify/notifier.go b/services/notify/notifier.go
@@ -79,5 +79,5 @@ type Notifier interface {
 
 	CreateCommitStatus(ctx context.Context, repo *repo_model.Repository, commit *repository.PushCommit, sender *user_model.User, status *git_model.CommitStatus)
 
-	CreateWorkflowJob(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask)
+	WorkflowJobStatusUpdate(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask)
 }
diff --git a/services/notify/notify.go b/services/notify/notify.go
@@ -376,8 +376,8 @@ func CreateCommitStatus(ctx context.Context, repo *repo_model.Repository, commit
 	}
 }
 
-func CreateWorkflowJob(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask) {
+func WorkflowJobStatusUpdate(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask) {
 	for _, notifier := range notifiers {
-		notifier.CreateWorkflowJob(ctx, repo, sender, job, task)
+		notifier.WorkflowJobStatusUpdate(ctx, repo, sender, job, task)
 	}
 }
diff --git a/services/notify/null.go b/services/notify/null.go
@@ -214,5 +214,5 @@ func (*NullNotifier) ChangeDefaultBranch(ctx context.Context, repo *repo_model.R
 func (*NullNotifier) CreateCommitStatus(ctx context.Context, repo *repo_model.Repository, commit *repository.PushCommit, sender *user_model.User, status *git_model.CommitStatus) {
 }
 
-func (*NullNotifier) CreateWorkflowJob(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask) {
+func (*NullNotifier) WorkflowJobStatusUpdate(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask) {
 }
diff --git a/services/webhook/notifier.go b/services/webhook/notifier.go
@@ -5,6 +5,7 @@ package webhook
 
 import (
 	"context"
+	"fmt"
 
 	actions_model "code.gitea.io/gitea/models/actions"
 	"code.gitea.io/gitea/models/db"
@@ -944,7 +945,7 @@ func notifyPackage(ctx context.Context, sender *user_model.User, pd *packages_mo
 	}
 }
 
-func (*webhookNotifier) CreateWorkflowJob(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask) {
+func (*webhookNotifier) WorkflowJobStatusUpdate(ctx context.Context, repo *repo_model.Repository, sender *user_model.User, job *actions_model.ActionRunJob, task *actions_model.ActionTask) {
 	source := EventSource{
 		Repository: repo,
 		Owner:      repo.Owner,
@@ -961,6 +962,19 @@ func (*webhookNotifier) CreateWorkflowJob(ctx context.Context, repo *repo_model.
 		return
 	}
 
+	jobIndex := 0
+	jobs, err := actions_model.GetRunJobsByRunID(ctx, job.RunID)
+	if err != nil {
+		log.Error("Error loading getting run jobs: %v", err)
+		return
+	}
+	for i, j := range jobs {
+		if j.ID == job.ID {
+			jobIndex = i
+			break
+		}
+	}
+
 	status, conclusion := toActionStatus(job.Status)
 	var runnerID int64
 	var runnerName string
@@ -987,9 +1001,13 @@ func (*webhookNotifier) CreateWorkflowJob(ctx context.Context, repo *repo_model.
 	if err := PrepareWebhooks(ctx, source, webhook_module.HookEventWorkflowJob, &api.WorkflowJobPayload{
 		Action: status,
 		WorkflowJob: &api.ActionWorkflowJob{
-			ID:          job.ID,
-			RunID:       job.RunID,
-			RunURL:      job.Run.HTMLURL(),
+			ID: job.ID,
+			// missing api endpoint for this location
+			URL:     fmt.Sprintf("%s/actions/runs/%d/jobs/%d", repo.APIURL(), job.RunID, job.ID),
+			HtmlURL: fmt.Sprintf("%s/jobs/%d", job.Run.HTMLURL(), jobIndex),
+			RunID:   job.RunID,
+			// Missing api endpoint for this location, artifacts are available under a nested url
+			RunURL:      fmt.Sprintf("%s/actions/runs/%d", repo.APIURL(), job.RunID),
 			Name:        job.Name,
 			Labels:      job.RunsOn,
 			RunAttempt:  job.Attempt,

Original file line number	Diff line number	Diff line change
`@@ -221,7 +221,7 @@ func (s *Service) UpdateTask(`
`221`	`221`	`}`
`222`	`222`
`223`	`223`	`if task.Status.IsDone() {`
`224`		`- notifier.CreateWorkflowJob(ctx, task.Job.Run.Repo, task.Job.Run.TriggerUser, task.Job, task)`
	`224`	`+ notifier.WorkflowJobStatusUpdate(ctx, task.Job.Run.Repo, task.Job.Run.TriggerUser, task.Job, task)`
`225`	`225`	`}`
`226`	`226`
`227`	`227`	`if req.Msg.State.Result != runnerv1.Result_RESULT_UNSPECIFIED {`
Original file line number	Diff line number	Diff line change
`@@ -460,7 +460,7 @@ func rerunJob(ctx context_module.Context, job actions_model.ActionRunJob, shou`
`460`	`460`
`461`	`461`	`actions_service.CreateCommitStatus(ctx, job)`
`462`	`462`	`_ = job.LoadAttributes(ctx)`
`463`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
	`463`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
`464`	`464`
`465`	`465`	`return nil`
`466`	`466`	`}`
`@@ -559,7 +559,7 @@ func Cancel(ctx *context_module.Context) {`
`559`	`559`
`560`	`560`	`for _, job := range updatedjobs {`
`561`	`561`	`_ = job.LoadAttributes(ctx)`
`562`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
	`562`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
`563`	`563`	`}`
`564`	`564`
`565`	`565`	`ctx.JSON(http.StatusOK, struct{}{})`
`@@ -605,7 +605,7 @@ func Approve(ctx *context_module.Context) {`
`605`	`605`
`606`	`606`	`for _, job := range updatedjobs {`
`607`	`607`	`_ = job.LoadAttributes(ctx)`
`608`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
	`608`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
`609`	`609`	`}`
`610`	`610`
`611`	`611`	`ctx.JSON(http.StatusOK, struct{}{})`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ func stopTasks(ctx context.Context, opts actions_model.FindTaskOptions) error {`
`71`	`71`	`CreateCommitStatus(ctx, jobs...)`
`72`	`72`	`for _, job := range jobs {`
`73`	`73`	`_ = job.LoadAttributes(ctx)`
`74`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
	`74`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
`75`	`75`	`}`
`76`	`76`	`return nil`
`77`	`77`	`}`
`@@ -103,7 +103,7 @@ func CancelAbandonedJobs(ctx context.Context) error {`
`103`	`103`	`CreateCommitStatus(ctx, job)`
`104`	`104`	`if updated {`
`105`	`105`	`_ = job.LoadAttributes(ctx)`
`106`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
	`106`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ func checkJobsOfRun(ctx context.Context, runID int64) error {`
`76`	`76`	`CreateCommitStatus(ctx, jobs...)`
`77`	`77`	`for _, job := range updatedjobs {`
`78`	`78`	`_ = job.LoadAttributes(ctx)`
`79`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
	`79`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, nil)`
`80`	`80`	`}`
`81`	`81`	`return nil`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -365,7 +365,7 @@ func handleWorkflows(`
`365`	`365`	`}`
`366`	`366`	`CreateCommitStatus(ctx, alljobs...)`
`367`	`367`	`for _, job := range alljobs {`
`368`		`- notifier.CreateWorkflowJob(ctx, input.Repo, input.Doer, job, nil)`
	`368`	`+ notifier.WorkflowJobStatusUpdate(ctx, input.Repo, input.Doer, job, nil)`
`369`	`369`	`}`
`370`	`370`	`}`
`371`	`371`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ func CreateScheduleTask(ctx context.Context, cron *actions_model.ActionSchedule)`
`158`	`158`	`log.Error("LoadAttributes: %v", err)`
`159`	`159`	`}`
`160`	`160`	`for _, job := range allJobs {`
`161`		`- notifier.CreateWorkflowJob(ctx, run.Repo, run.TriggerUser, job, nil)`
	`161`	`+ notifier.WorkflowJobStatusUpdate(ctx, run.Repo, run.TriggerUser, job, nil)`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`// Return nil if no errors occurred`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ func PickTask(ctx context.Context, runner actions_model.ActionRunner) (runnerv`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`CreateCommitStatus(ctx, job)`
`80`		`- notifier.CreateWorkflowJob(ctx, job.Run.Repo, job.Run.TriggerUser, job, actionTask)`
	`80`	`+ notifier.WorkflowJobStatusUpdate(ctx, job.Run.Repo, job.Run.TriggerUser, job, actionTask)`
`81`	`81`
`82`	`82`	`return task, true, nil`
`83`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -278,7 +278,7 @@ func DispatchActionWorkflow(ctx reqctx.RequestContext, doer *user_model.User, re`
`278`	`278`	`}`
`279`	`279`	`CreateCommitStatus(ctx, allJobs...)`
`280`	`280`	`for _, job := range allJobs {`
`281`		`- notifier.CreateWorkflowJob(ctx, repo, doer, job, nil)`
	`281`	`+ notifier.WorkflowJobStatusUpdate(ctx, repo, doer, job, nil)`
`282`	`282`	`}`
`283`	`283`
`284`	`284`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -79,5 +79,5 @@ type Notifier interface {`
`79`	`79`
`80`	`80`	`CreateCommitStatus(ctx context.Context, repo repo_model.Repository, commit repository.PushCommit, sender user_model.User, status git_model.CommitStatus)`
`81`	`81`
`82`		`- CreateWorkflowJob(ctx context.Context, repo repo_model.Repository, sender user_model.User, job actions_model.ActionRunJob, task actions_model.ActionTask)`
	`82`	`+ WorkflowJobStatusUpdate(ctx context.Context, repo repo_model.Repository, sender user_model.User, job actions_model.ActionRunJob, task actions_model.ActionTask)`
`83`	`83`	`}`