diff --git a/options/locale/locale_en-US.json b/options/locale/locale_en-US.json index bee657b8213..06fe859b86d 100644 --- a/options/locale/locale_en-US.json +++ b/options/locale/locale_en-US.json @@ -3854,6 +3854,9 @@ "actions.runs.all_workflows": "All Workflows", "actions.runs.other_workflows": "Other workflows", "actions.runs.other_workflows_tooltip": "Workflows that were executed in this repository but do not exist on the default branch.", + "actions.runs.reusable_workflows": "Reusable workflows", + "actions.runs.reusable_workflows_tooltip": "Workflows that can only be called by other workflows.", + "actions.runs.reusable_workflow_no_runs": "This workflow can only be called by other workflows.", "actions.runs.workflow_run_count_1": "%d workflow run", "actions.runs.workflow_run_count_n": "%d workflow runs", "actions.runs.commit": "Commit", diff --git a/routers/web/repo/actions/actions.go b/routers/web/repo/actions/actions.go index 1d1ee7bff63..9f7ba159647 100644 --- a/routers/web/repo/actions/actions.go +++ b/routers/web/repo/actions/actions.go @@ -47,6 +47,7 @@ type WorkflowInfo struct { EntryName string ErrMsg string Workflow *act_model.Workflow + Reusable bool // only triggered by workflow_call } type workflowBadge struct { @@ -226,11 +227,13 @@ func prepareWorkflowTemplate(ctx *context.Context, commit *git.Commit) (workflow workflows = append(workflows, workflow) continue } - if _, err := actions.GetEventsFromContent(content); err != nil { + events, err := actions.GetEventsFromContent(content) + if err != nil { workflow.ErrMsg = ctx.Locale.TrString("actions.runs.invalid_workflow_helper", err.Error()) workflows = append(workflows, workflow) continue } + workflow.Reusable = len(events) == 0 && slices.Contains(wf.On(), "workflow_call") // events never include workflow_call workflow.Workflow = wf // The workflow must contain at least one job without "needs". Otherwise, a deadlock will occur and no jobs will be able to run. hasJobWithoutNeeds := false @@ -262,7 +265,11 @@ func prepareWorkflowTemplate(ctx *context.Context, commit *git.Commit) (workflow workflows = append(workflows, workflow) } + reusableWorkflows := slices.DeleteFunc(slices.Clone(workflows), func(w WorkflowInfo) bool { return !w.Reusable }) ctx.Data["workflows"] = workflows + ctx.Data["ReusableWorkflows"] = reusableWorkflows + ctx.Data["CurWorkflowIsReusable"] = ctx.FormInt64("scoped_workflow_source_repo_id") == 0 && + slices.ContainsFunc(reusableWorkflows, func(w WorkflowInfo) bool { return w.EntryName == curWorkflowID }) ctx.Data["RepoLink"] = ctx.Repo.Repository.Link() ctx.Data["RepoID"] = ctx.Repo.Repository.ID ctx.Data["AllowDisableOrEnableWorkflow"] = ctx.Repo.Permission.IsAdmin() diff --git a/templates/repo/actions/list.tmpl b/templates/repo/actions/list.tmpl index 136d3eaf7ad..9d64145c5ac 100644 --- a/templates/repo/actions/list.tmpl +++ b/templates/repo/actions/list.tmpl @@ -1,7 +1,7 @@ {{template "base/head" .}} -{{$showCreateWorkflowBadge := Iif .WorkflowBadge true false}} -{{$showEnableDisableWorkflow := and .AllowDisableOrEnableWorkflow .CurWorkflowIsListed $.CurWorkflow}} +{{$showCreateWorkflowBadge := and .WorkflowBadge (not .CurWorkflowIsReusable)}} +{{$showEnableDisableWorkflow := and .AllowDisableOrEnableWorkflow .CurWorkflowIsListed $.CurWorkflow (or (not .CurWorkflowIsReusable) .CurWorkflowDisabled)}}
{{template "repo/header" .}} @@ -101,7 +101,7 @@ {{end}}
- {{template "repo/actions/runs_list" dict "ActionRunListData" $.ActionRunListData}} + {{template "repo/actions/runs_list" dict "ActionRunListData" $.ActionRunListData "CurWorkflowIsReusable" $.CurWorkflowIsReusable}} {{template "base/paginate" dict "Page" $.Page}}
diff --git a/templates/repo/actions/runs_list.tmpl b/templates/repo/actions/runs_list.tmpl index a5c403d5781..6fbc8e27c56 100644 --- a/templates/repo/actions/runs_list.tmpl +++ b/templates/repo/actions/runs_list.tmpl @@ -6,7 +6,7 @@ {{if not $data.ActionRuns}}
{{svg "octicon-no-entry" 48}} -

{{if $data.IsFiltered}}{{ctx.Locale.Tr "actions.runs.no_results"}}{{else}}{{ctx.Locale.Tr "actions.runs.no_runs"}}{{end}}

+

{{if $data.IsFiltered}}{{ctx.Locale.Tr "actions.runs.no_results"}}{{else if $.CurWorkflowIsReusable}}{{ctx.Locale.Tr "actions.runs.reusable_workflow_no_runs"}}{{else}}{{ctx.Locale.Tr "actions.runs.no_runs"}}{{end}}

{{end}} {{range $run := $data.ActionRuns}} diff --git a/templates/repo/actions/sidebar.tmpl b/templates/repo/actions/sidebar.tmpl index 4a2dfafdc01..31c40ccc5eb 100644 --- a/templates/repo/actions/sidebar.tmpl +++ b/templates/repo/actions/sidebar.tmpl @@ -1,7 +1,7 @@
{{ctx.Locale.Tr "actions.runs.all_workflows"}} - {{range .workflows}} + {{range .workflows}}{{if not .Reusable}} {{.DisplayName}} @@ -13,6 +13,29 @@
{{ctx.Locale.Tr "disabled"}}
{{end}} + {{end}}{{end}} + {{if .ReusableWorkflows}} +
+ + + {{ctx.Locale.Tr "actions.runs.reusable_workflows"}} + {{len .ReusableWorkflows}} + + +
+ {{range .ReusableWorkflows}} + + {{.DisplayName}} + {{if .ErrMsg}} + {{svg "octicon-alert" 16 "tw-text-red"}} + {{end}} + {{if $.ActionsConfig.IsWorkflowDisabled .EntryName}} +
{{ctx.Locale.Tr "disabled"}}
+ {{end}} + + {{end}} +
+
{{end}} {{range .ScopedWorkflowGroups}}
diff --git a/tests/integration/actions_reusable_workflow_test.go b/tests/integration/actions_reusable_workflow_test.go index 0f4b8382e6d..ccbe6f1d621 100644 --- a/tests/integration/actions_reusable_workflow_test.go +++ b/tests/integration/actions_reusable_workflow_test.go @@ -8,12 +8,14 @@ import ( "fmt" "net/http" "net/url" + "strings" "testing" "time" runnerv1 "gitea.dev/actionslib/runner/v1" actions_model "gitea.dev/models/actions" auth_model "gitea.dev/models/auth" + "gitea.dev/models/db" perm_model "gitea.dev/models/perm" repo_model "gitea.dev/models/repo" "gitea.dev/models/unit" @@ -359,6 +361,47 @@ jobs: run = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: runID}) assert.Equal(t, actions_model.StatusSuccess, run.Status) }) + + t.Run("Sidebar groups workflow_call-only workflows", func(t *testing.T) { + require.NoError(t, db.Insert(t.Context(), &actions_model.ActionRun{ + Title: "former push run", RepoID: repo.ID, OwnerID: repo.OwnerID, WorkflowID: "reusable2.yaml", Index: 9701, + TriggerUserID: user2.ID, Ref: "refs/heads/" + repo.DefaultBranch, Event: "push", TriggerEvent: "push", + Status: actions_model.StatusSuccess, + })) + job := "jobs:\n job1:\n runs-on: ubuntu-latest\n steps:\n - run: echo\n" + testCreateFileInBranch(t, user2, repo, createFileInBranchOptions{}, map[string]string{ + ".gitea/workflows/mixed.yaml": "on: [workflow_call, workflow_dispatch]\n" + job, + ".gitea/workflows/no-events.yaml": "on: []\n" + job, + }) + MakeRequest(t, NewRequest(t, "PUT", fmt.Sprintf("/api/v1/repos/%s/actions/workflows/reusable2.yaml/disable", repo.FullName())). + AddTokenAuth(user2Token), http.StatusNoContent) + + doc := NewHTMLParser(t, user2Session.MakeRequest(t, NewRequest(t, "GET", repo.Link()+"/actions?workflow=reusable1.yaml"), http.StatusOK).Body) + listed := func(name string) int { + return doc.Find(fmt.Sprintf(`.flex-container-nav > .menu > a.item[href*="workflow=%s&"]`, name)).Length() + } + grouped := func(name string) int { + return doc.Find(fmt.Sprintf(`.flex-container-nav details .menu a.item[href*="workflow=%s&"]`, name)).Length() + } + assert.Equal(t, "2", doc.Find(".flex-container-nav details summary .ui.label").Text()) + assert.Equal(t, 1, grouped("reusable1.yaml")) + assert.Equal(t, 1, grouped("reusable2.yaml")) + assert.Equal(t, 1, doc.Find(`.flex-container-nav details a.item[href*="workflow=reusable2.yaml&"] .ui.red.label`).Length()) + assert.Zero(t, listed("reusable1.yaml")) + assert.Equal(t, 1, listed("caller.yaml")) + assert.Equal(t, 1, listed("mixed.yaml")) + assert.Equal(t, 1, listed("no-events.yaml")) + assert.Equal(t, "This workflow can only be called by other workflows.", strings.TrimSpace(doc.Find(".empty-placeholder h2").Text())) + assert.Zero(t, doc.Find(`[data-url*="/disable?workflow=reusable1.yaml"]`).Length()) + assert.Zero(t, doc.Find(`[data-modal="#workflow-status-badge-modal"]`).Length()) + + doc = NewHTMLParser(t, user2Session.MakeRequest(t, NewRequest(t, "GET", repo.Link()+"/actions?workflow=reusable2.yaml"), http.StatusOK).Body) + assert.Equal(t, 1, doc.Find(`[data-url*="/enable?workflow=reusable2.yaml"]`).Length()) + + doc = NewHTMLParser(t, user2Session.MakeRequest(t, NewRequest(t, "GET", repo.Link()+"/actions?workflow=mixed.yaml"), http.StatusOK).Body) + assert.Equal(t, 1, doc.Find(`[data-url*="/disable?workflow=mixed.yaml"]`).Length()) + assert.Equal(t, 1, doc.Find(`[data-modal="#workflow-status-badge-modal"]`).Length()) + }) }) t.Run("Cross-repo reusable workflow with collaborative owner", func(t *testing.T) {