Merge pull request '[UI] Actions: Link to Workflow in View' (#1866) from n0toose/forgejo:forgejo-add-workflow-link into forgejo

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/1866
Reviewed-by: Gusted <gusted@noreply.codeberg.org>

options/locale/locale_en-US.ini

@@ -3638,6 +3638,7 @@ runs.all_workflows = All Workflows
 runs.commit = Commit
 runs.scheduled = Scheduled
 runs.pushed_by = pushed by
+runs.workflow = Workflow
 runs.invalid_workflow_helper = Workflow config file is invalid. Please check your config file: %s
 runs.no_matching_online_runner_helper = No matching online runner with label: %s
 runs.actor = Actor

routers/web/repo/actions/view.go

@@ -1,4 +1,5 @@
 // Copyright 2022 The Gitea Authors. All rights reserved.
+// Copyright 2024 The Forgejo Authors. All rights reserved.
 // SPDX-License-Identifier: MIT
 
 package actions
@@ -35,13 +36,19 @@ func View(ctx *context_module.Context) {
 	ctx.Data["PageIsActions"] = true
 	runIndex := ctx.ParamsInt64("run")
 	jobIndex := ctx.ParamsInt64("job")
+
+	job, _ := getRunJobs(ctx, runIndex, jobIndex)
+	if ctx.Written() {
+		return
+	}
+
+	workflowName := job.Run.WorkflowID
+
 	ctx.Data["RunIndex"] = runIndex
 	ctx.Data["JobIndex"] = jobIndex
 	ctx.Data["ActionsURL"] = ctx.Repo.RepoLink + "/actions"
-
+	ctx.Data["WorkflowName"] = workflowName
-	if getRunJobs(ctx, runIndex, jobIndex); ctx.Written() {
+	ctx.Data["WorkflowURL"] = ctx.Repo.RepoLink + "/actions?workflow=" + workflowName
-		return
-	}
 
 	ctx.HTML(http.StatusOK, tplViewActions)
 }
@@ -131,6 +138,7 @@ type ViewJob struct {
 type ViewCommit struct {
 	LocaleCommit   string     `json:"localeCommit"`
 	LocalePushedBy string     `json:"localePushedBy"`
+	LocaleWorkflow string     `json:"localeWorkflow"`
 	ShortSha       string     `json:"shortSHA"`
 	Link           string     `json:"link"`
 	Pusher         ViewUser   `json:"pusher"`
@@ -213,6 +221,7 @@ func ViewPost(ctx *context_module.Context) {
 	resp.State.Run.Commit = ViewCommit{
 		LocaleCommit:   ctx.Locale.TrString("actions.runs.commit"),
 		LocalePushedBy: ctx.Locale.TrString("actions.runs.pushed_by"),
+		LocaleWorkflow: ctx.Locale.TrString("actions.runs.workflow"),
 		ShortSha:       base.ShortSha(run.CommitSHA),
 		Link:           fmt.Sprintf("%s/commit/%s", run.Repo.Link(), run.CommitSHA),
 		Pusher:         pusher,

templates/repo/actions/view.tmpl

@@ -6,6 +6,8 @@
 		data-run-index="{{.RunIndex}}"
 		data-job-index="{{.JobIndex}}"
 		data-actions-url="{{.ActionsURL}}"
+		data-workflow-name="{{.WorkflowName}}"
+		data-workflow-url="{{.WorkflowURL}}"
 		data-locale-approve="{{ctx.Locale.Tr "repo.diff.review.approve"}}"
 		data-locale-cancel="{{ctx.Locale.Tr "cancel"}}"
 		data-locale-rerun="{{ctx.Locale.Tr "rerun"}}"

tests/integration/actions_route_test.go

@@ -22,12 +22,21 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func GetWorkflowRunRedirectURI(t *testing.T, repoURL, workflow string) string {
+	t.Helper()
+
+	req := NewRequest(t, "GET", fmt.Sprintf("%s/actions/workflows/%s/runs/latest", repoURL, workflow))
+	resp := MakeRequest(t, req, http.StatusTemporaryRedirect)
+
+	return resp.Header().Get("Location")
+}
+
 func TestActionsWebRouteLatestWorkflowRun(t *testing.T) {
 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 		user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 
 		// create the repo
-		repo, _, f := CreateDeclarativeRepo(t, user2, "",
+		repo, _, f := CreateDeclarativeRepo(t, user2, "actionsTestRepo",
 			[]unit_model.Type{unit_model.TypeActions}, nil,
 			[]*files_service.ChangeRepoFile{
 				{
@@ -44,23 +53,17 @@ func TestActionsWebRouteLatestWorkflowRun(t *testing.T) {
 		)
 		defer f()
 
+		repoURL := repo.HTMLURL()
+
 		t.Run("valid workflows", func(t *testing.T) {
 			defer tests.PrintCurrentTest(t)()
 
-			// helpers
-			getWorkflowRunRedirectURI := func(workflow string) string {
-				req := NewRequest(t, "GET", fmt.Sprintf("%s/actions/workflows/%s/runs/latest", repo.HTMLURL(), workflow))
-				resp := MakeRequest(t, req, http.StatusTemporaryRedirect)
-
-				return resp.Header().Get("Location")
-			}
-
 			// two runs have been created
 			assert.Equal(t, 2, unittest.GetCount(t, &actions_model.ActionRun{RepoID: repo.ID}))
 
 			// Get the redirect URIs for both workflows
-			workflowOneURI := getWorkflowRunRedirectURI("workflow-1.yml")
+			workflowOneURI := GetWorkflowRunRedirectURI(t, repoURL, "workflow-1.yml")
-			workflowTwoURI := getWorkflowRunRedirectURI("workflow-2.yml")
+			workflowTwoURI := GetWorkflowRunRedirectURI(t, repoURL, "workflow-2.yml")
 
 			// Verify that the two are different.
 			assert.NotEqual(t, workflowOneURI, workflowTwoURI)
@@ -77,17 +80,35 @@ func TestActionsWebRouteLatestWorkflowRun(t *testing.T) {
 			assert.Equal(t, workflowTwoURI, workflowTwo.HTMLURL())
 		})
 
+		t.Run("check if workflow page shows file name", func(t *testing.T) {
+			defer tests.PrintCurrentTest(t)()
+
+			// Get the redirect URI
+			workflow := "workflow-1.yml"
+			workflowOneURI := GetWorkflowRunRedirectURI(t, repoURL, workflow)
+
+			// Fetch the page that shows information about the run initiated by "workflow-1.yml".
+			// routers/web/repo/actions/view.go: data-workflow-url is constructed using data-workflow-name.
+			req := NewRequest(t, "GET", workflowOneURI)
+			resp := MakeRequest(t, req, http.StatusOK)
+			htmlDoc := NewHTMLParser(t, resp.Body)
+
+			// Verify that URL of the workflow is shown correctly.
+			expectedURL := fmt.Sprintf("/user2/actionsTestRepo/actions?workflow=%s", workflow)
+			htmlDoc.AssertElement(t, fmt.Sprintf("#repo-action-view[data-workflow-url=\"%s\"]", expectedURL), true)
+		})
+
 		t.Run("existing workflow, non-existent branch", func(t *testing.T) {
 			defer tests.PrintCurrentTest(t)()
 
-			req := NewRequest(t, "GET", fmt.Sprintf("%s/actions/workflows/workflow-1.yml/runs/latest?branch=foobar", repo.HTMLURL()))
+			req := NewRequest(t, "GET", fmt.Sprintf("%s/actions/workflows/workflow-1.yml/runs/latest?branch=foobar", repoURL))
 			MakeRequest(t, req, http.StatusNotFound)
 		})
 
 		t.Run("non-existing workflow", func(t *testing.T) {
 			defer tests.PrintCurrentTest(t)()
 
-			req := NewRequest(t, "GET", fmt.Sprintf("%s/actions/workflows/workflow-3.yml/runs/latest", repo.HTMLURL()))
+			req := NewRequest(t, "GET", fmt.Sprintf("%s/actions/workflows/workflow-3.yml/runs/latest", repoURL))
 			MakeRequest(t, req, http.StatusNotFound)
 		})
 	})

tests/integration/pull_reopen_test.go

@@ -26,6 +26,7 @@ import (
 	repo_service "code.gitea.io/gitea/services/repository"
 	files_service "code.gitea.io/gitea/services/repository/files"
 	"code.gitea.io/gitea/tests"
+
 	"github.com/stretchr/testify/assert"
 )
 

web_src/js/components/RepoActionView.vue

@@ -17,6 +17,8 @@ const sfc = {
     runIndex: String,
     jobIndex: String,
     actionsURL: String,
+    workflowName: String,
+    workflowURL: String,
     locale: Object,
   },
 
@@ -56,6 +58,7 @@ const sfc = {
         commit: {
           localeCommit: '',
           localePushedBy: '',
+          localeWorkflow: '',
           shortSHA: '',
           link: '',
           pusher: {
@@ -330,6 +333,8 @@ export function initRepositoryActionView() {
     runIndex: el.getAttribute('data-run-index'),
     jobIndex: el.getAttribute('data-job-index'),
     actionsURL: el.getAttribute('data-actions-url'),
+    workflowName: el.getAttribute('data-workflow-name'),
+    workflowURL: el.getAttribute('data-workflow-url'),
     locale: {
       approve: el.getAttribute('data-locale-approve'),
       cancel: el.getAttribute('data-locale-cancel'),
@@ -377,7 +382,7 @@ export function initRepositoryActionView() {
           {{ locale.rerun_all }}
         </button>
       </div>
-      <div class="action-commit-summary">
+      <div class="action-summary">
         {{ run.commit.localeCommit }}
         <a class="muted" :href="run.commit.link">{{ run.commit.shortSHA }}</a>
         {{ run.commit.localePushedBy }}
@@ -386,6 +391,10 @@ export function initRepositoryActionView() {
           <a :href="run.commit.branch.link">{{ run.commit.branch.name }}</a>
         </span>
       </div>
+      <div class="action-summary">
+        {{ run.commit.localeWorkflow }}
+        <a class="muted" :href="workflowURL">{{ workflowName }}</a>
+      </div>
     </div>
     <div class="action-view-body">
       <div class="action-view-left">
@@ -511,7 +520,7 @@ export function initRepositoryActionView() {
   flex: 1;
 }
 
-.action-commit-summary {
+.action-summary {
   display: flex;
   gap: 5px;
   margin: 0 0 0 28px;