From aac07d010f261c00fb3bd9644c71dc108c668c11 Mon Sep 17 00:00:00 2001
From: yp05327 <576951401@qq.com>
Date: Tue, 14 Mar 2023 16:27:03 +0900
Subject: [PATCH] Add workflow error notification in ui (#23404)
---------
Co-authored-by: techknowlogick <matti@mdranta.net>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
---
modules/actions/workflows.go | 40 ++++++++++++++++++++---------
options/locale/locale_en-US.ini | 2 ++
routers/web/repo/actions/actions.go | 26 ++++++++++++++++---
templates/repo/actions/list.tmpl | 12 ++++++++-
4 files changed, 64 insertions(+), 16 deletions(-)
diff --git a/modules/actions/workflows.go b/modules/actions/workflows.go
index 7f0e6e4564..98fc831c31 100644
--- a/modules/actions/workflows.go
+++ b/modules/actions/workflows.go
@@ -44,6 +44,32 @@ func ListWorkflows(commit *git.Commit) (git.Entries, error) {
return ret, nil
}
+func GetContentFromEntry(entry *git.TreeEntry) ([]byte, error) {
+ f, err := entry.Blob().DataAsync()
+ if err != nil {
+ return nil, err
+ }
+ content, err := io.ReadAll(f)
+ _ = f.Close()
+ if err != nil {
+ return nil, err
+ }
+ return content, nil
+}
+
+func GetEventsFromContent(content []byte) ([]*jobparser.Event, error) {
+ workflow, err := model.ReadWorkflow(bytes.NewReader(content))
+ if err != nil {
+ return nil, err
+ }
+ events, err := jobparser.ParseRawOn(&workflow.RawOn)
+ if err != nil {
+ return nil, err
+ }
+
+ return events, nil
+}
+
func DetectWorkflows(commit *git.Commit, triggedEvent webhook_module.HookEventType, payload api.Payloader) (map[string][]byte, error) {
entries, err := ListWorkflows(commit)
if err != nil {
@@ -52,21 +78,11 @@ func DetectWorkflows(commit *git.Commit, triggedEvent webhook_module.HookEventTy
workflows := make(map[string][]byte, len(entries))
for _, entry := range entries {
- f, err := entry.Blob().DataAsync()
+ content, err := GetContentFromEntry(entry)
if err != nil {
return nil, err
}
- content, err := io.ReadAll(f)
- _ = f.Close()
- if err != nil {
- return nil, err
- }
- workflow, err := model.ReadWorkflow(bytes.NewReader(content))
- if err != nil {
- log.Warn("ignore invalid workflow %q: %v", entry.Name(), err)
- continue
- }
- events, err := jobparser.ParseRawOn(&workflow.RawOn)
+ events, err := GetEventsFromContent(content)
if err != nil {
log.Warn("ignore invalid workflow %q: %v", entry.Name(), err)
continue
diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini
index e793c3ef03..afcf9ade04 100644
--- a/options/locale/locale_en-US.ini
+++ b/options/locale/locale_en-US.ini
@@ -3360,5 +3360,7 @@ runs.open_tab = %d Open
runs.closed_tab = %d Closed
runs.commit = Commit
runs.pushed_by = Pushed by
+runs.valid_workflow_helper = Workflow config file is valid.
+runs.invalid_workflow_helper = Workflow config file is invalid. Please check your config file: %s
need_approval_desc = Need approval to run workflows for fork pull request.
diff --git a/routers/web/repo/actions/actions.go b/routers/web/repo/actions/actions.go
index 0e7a95ed07..dd2dc55bd5 100644
--- a/routers/web/repo/actions/actions.go
+++ b/routers/web/repo/actions/actions.go
@@ -23,6 +23,12 @@ const (
tplViewActions base.TplName = "repo/actions/view"
)
+type Workflow struct {
+ Entry git.TreeEntry
+ IsInvalid bool
+ ErrMsg string
+}
+
// MustEnableActions check if actions are enabled in settings
func MustEnableActions(ctx *context.Context) {
if !setting.Actions.Enabled {
@@ -47,7 +53,7 @@ func List(ctx *context.Context) {
ctx.Data["Title"] = ctx.Tr("actions.actions")
ctx.Data["PageIsActions"] = true
- var workflows git.Entries
+ var workflows []Workflow
if empty, err := ctx.Repo.GitRepo.IsEmpty(); err != nil {
ctx.Error(http.StatusInternalServerError, err.Error())
return
@@ -62,13 +68,27 @@ func List(ctx *context.Context) {
ctx.Error(http.StatusInternalServerError, err.Error())
return
}
- workflows, err = actions.ListWorkflows(commit)
+ entries, err := actions.ListWorkflows(commit)
if err != nil {
ctx.Error(http.StatusInternalServerError, err.Error())
return
}
+ workflows = make([]Workflow, 0, len(entries))
+ for _, entry := range entries {
+ workflow := Workflow{Entry: *entry}
+ content, err := actions.GetContentFromEntry(entry)
+ if err != nil {
+ ctx.Error(http.StatusInternalServerError, err.Error())
+ return
+ }
+ _, err = actions.GetEventsFromContent(content)
+ if err != nil {
+ workflow.IsInvalid = true
+ workflow.ErrMsg = err.Error()
+ }
+ workflows = append(workflows, workflow)
+ }
}
-
ctx.Data["workflows"] = workflows
ctx.Data["RepoLink"] = ctx.Repo.Repository.Link()
diff --git a/templates/repo/actions/list.tmpl b/templates/repo/actions/list.tmpl
index c5abff5251..5e8313fa5e 100644
--- a/templates/repo/actions/list.tmpl
+++ b/templates/repo/actions/list.tmpl
@@ -9,7 +9,17 @@
<a class="item{{if not $.CurWorkflow}} active{{end}}" href="{{$.Link}}">{{.locale.Tr "actions.runs.all_workflows"}}</a>
<div class="divider"></div>
{{range .workflows}}
- <a class="item{{if eq .Name $.CurWorkflow}} active{{end}}" href="{{$.Link}}?workflow={{.Name}}">{{.Name}}</a>
+ <a class="item{{if eq .Entry.Name $.CurWorkflow}} active{{end}}" href="{{$.Link}}?workflow={{.Entry.Name}}">{{.Entry.Name}}
+ {{if .IsInvalid}}
+ <span class="tooltip" data-content="{{$.locale.Tr "actions.runs.invalid_workflow_helper" (.ErrMsg)}}">
+ <i class="warning icon red"></i>
+ </span>
+ {{else}}
+ <span class="tooltip" data-content="{{$.locale.Tr "actions.runs.valid_workflow_helper"}}">
+ <i class="check icon green"></i>
+ </span>
+ {{end}}
+ </a>
{{end}}
</div>
</div>