From 57ed788b3536ef1852d178f5e7f66d6498cc7eec Mon Sep 17 00:00:00 2001 From: yp05327 <576951401@qq.com> Date: Fri, 10 Mar 2023 06:22:24 +0000 Subject: [PATCH 1/6] add workflow error check --- 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 7f0e6e456436b..98fc831c31cef 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() - if err != nil { - return nil, err - } - content, err := io.ReadAll(f) - _ = f.Close() + content, err := GetContentFromEntry(entry) 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 3695bd0384aa9..b6940fb2d063e 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -3348,5 +3348,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. 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 e5496676a9dd3..36104a2bdd0b6 100644 --- a/routers/web/repo/actions/actions.go +++ b/routers/web/repo/actions/actions.go @@ -23,6 +23,11 @@ const ( tplViewActions base.TplName = "repo/actions/view" ) +type WorkFlow struct { + Entry git.TreeEntry + IsInvalid bool +} + // MustEnableActions check if actions are enabled in settings func MustEnableActions(ctx *context.Context) { if !setting.Actions.Enabled { @@ -47,7 +52,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 +67,28 @@ 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 + } else { + workflow.IsInvalid = false + } + 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 c5abff52513b2..24a754f26a338 100644 --- a/templates/repo/actions/list.tmpl +++ b/templates/repo/actions/list.tmpl @@ -9,7 +9,17 @@ {{.locale.Tr "actions.runs.all_workflows"}}
{{range .workflows}} - {{.Name}} + {{.Entry.Name}} + {{if .IsInvalid}} + + + + {{else}} + + + + {{end}} + {{end}} From f03842332fbfe96f037a62a49002e5dde558a96a Mon Sep 17 00:00:00 2001 From: techknowlogick Date: Fri, 10 Mar 2023 01:33:14 -0500 Subject: [PATCH 2/6] Update templates/repo/actions/list.tmpl --- templates/repo/actions/list.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/repo/actions/list.tmpl b/templates/repo/actions/list.tmpl index 24a754f26a338..ffb29ef55983c 100644 --- a/templates/repo/actions/list.tmpl +++ b/templates/repo/actions/list.tmpl @@ -17,7 +17,7 @@ {{else}} - + {{end}} {{end}} From 77a898a68925ccd9bfa3f9531251615f7a3b7d55 Mon Sep 17 00:00:00 2001 From: yp05327 <576951401@qq.com> Date: Sat, 11 Mar 2023 07:58:45 +0900 Subject: [PATCH 3/6] remove unnecessary code --- routers/web/repo/actions/actions.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/routers/web/repo/actions/actions.go b/routers/web/repo/actions/actions.go index 36104a2bdd0b6..3a72b0afbe28c 100644 --- a/routers/web/repo/actions/actions.go +++ b/routers/web/repo/actions/actions.go @@ -83,8 +83,6 @@ func List(ctx *context.Context) { _, err = actions.GetEventsFromContent(content) if err != nil { workflow.IsInvalid = true - } else { - workflow.IsInvalid = false } workflows = append(workflows, workflow) } From 766725b2a6804f754502f645d7dd5bad745e28ae Mon Sep 17 00:00:00 2001 From: yp05327 <576951401@qq.com> Date: Tue, 14 Mar 2023 02:28:28 +0000 Subject: [PATCH 4/6] add ErrMsg --- options/locale/locale_en-US.ini | 2 +- routers/web/repo/actions/actions.go | 2 ++ templates/repo/actions/list.tmpl | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index ab8b105f89194..ca89bf05f1c1c 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -3351,6 +3351,6 @@ 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. +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 3a72b0afbe28c..c8f93a33d10dc 100644 --- a/routers/web/repo/actions/actions.go +++ b/routers/web/repo/actions/actions.go @@ -26,6 +26,7 @@ const ( type WorkFlow struct { Entry git.TreeEntry IsInvalid bool + ErrMsg string } // MustEnableActions check if actions are enabled in settings @@ -83,6 +84,7 @@ func List(ctx *context.Context) { _, err = actions.GetEventsFromContent(content) if err != nil { workflow.IsInvalid = true + workflow.ErrMsg = err.Error() } workflows = append(workflows, workflow) } diff --git a/templates/repo/actions/list.tmpl b/templates/repo/actions/list.tmpl index ffb29ef55983c..4c1ab509bcb24 100644 --- a/templates/repo/actions/list.tmpl +++ b/templates/repo/actions/list.tmpl @@ -11,7 +11,7 @@ {{range .workflows}} {{.Entry.Name}} {{if .IsInvalid}} - + {{else}} From 79911d080a40d53a6d4e9a1eb55c3e328dbaae92 Mon Sep 17 00:00:00 2001 From: yp05327 <576951401@qq.com> Date: Tue, 14 Mar 2023 02:30:14 +0000 Subject: [PATCH 5/6] improve icon location --- templates/repo/actions/list.tmpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/repo/actions/list.tmpl b/templates/repo/actions/list.tmpl index 4c1ab509bcb24..5e8313fa5e362 100644 --- a/templates/repo/actions/list.tmpl +++ b/templates/repo/actions/list.tmpl @@ -11,11 +11,11 @@ {{range .workflows}} {{.Entry.Name}} {{if .IsInvalid}} - + {{else}} - + {{end}} From 8a4eccbe7749def92f1b93fd4a34203fa9bdb7a8 Mon Sep 17 00:00:00 2001 From: yp05327 <576951401@qq.com> Date: Tue, 14 Mar 2023 04:22:04 +0000 Subject: [PATCH 6/6] rename WorkFlow to Workflow --- routers/web/repo/actions/actions.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/routers/web/repo/actions/actions.go b/routers/web/repo/actions/actions.go index c8f93a33d10dc..59c82cc67ed1b 100644 --- a/routers/web/repo/actions/actions.go +++ b/routers/web/repo/actions/actions.go @@ -23,7 +23,7 @@ const ( tplViewActions base.TplName = "repo/actions/view" ) -type WorkFlow struct { +type Workflow struct { Entry git.TreeEntry IsInvalid bool ErrMsg string @@ -53,7 +53,7 @@ func List(ctx *context.Context) { ctx.Data["Title"] = ctx.Tr("actions.actions") ctx.Data["PageIsActions"] = true - var workflows []WorkFlow + var workflows []Workflow if empty, err := ctx.Repo.GitRepo.IsEmpty(); err != nil { ctx.Error(http.StatusInternalServerError, err.Error()) return @@ -73,9 +73,9 @@ func List(ctx *context.Context) { ctx.Error(http.StatusInternalServerError, err.Error()) return } - workflows = make([]WorkFlow, 0, len(entries)) + workflows = make([]Workflow, 0, len(entries)) for _, entry := range entries { - workflow := WorkFlow{Entry: *entry} + workflow := Workflow{Entry: *entry} content, err := actions.GetContentFromEntry(entry) if err != nil { ctx.Error(http.StatusInternalServerError, err.Error())