diff --git a/models/project/column.go b/models/project/column.go index 9b9d874997edd..2c919354786b8 100644 --- a/models/project/column.go +++ b/models/project/column.go @@ -213,6 +213,18 @@ func GetColumn(ctx context.Context, columnID int64) (*Column, error) { return column, nil } +func GetColumnByProjectIDAndColumnName(ctx context.Context, projectID int64, columnName string) (*Column, error) { + board := new(Column) + has, err := db.GetEngine(ctx).Where("project_id=? AND title=?", projectID, columnName).Get(board) + if err != nil { + return nil, err + } else if !has { + return nil, ErrProjectColumnNotExist{ProjectID: projectID, Name: columnName} + } + + return board, nil +} + // UpdateColumn updates a project column func UpdateColumn(ctx context.Context, column *Column) error { var fieldToUpdate []string diff --git a/models/project/issue.go b/models/project/issue.go index 47d1537ec7389..936c05ef734c8 100644 --- a/models/project/issue.go +++ b/models/project/issue.go @@ -33,6 +33,19 @@ func deleteProjectIssuesByProjectID(ctx context.Context, projectID int64) error return err } +func AddIssueToColumn(ctx context.Context, issueID int64, newColumn *Column) error { + return db.Insert(ctx, &ProjectIssue{ + IssueID: issueID, + ProjectID: newColumn.ProjectID, + ProjectColumnID: newColumn.ID, + }) +} + +func MoveIssueToAnotherColumn(ctx context.Context, issueID int64, newColumn *Column) error { + _, err := db.GetEngine(ctx).Exec("UPDATE `project_issue` SET project_board_id=? WHERE issue_id=?", newColumn.ID, issueID) + return err +} + func (c *Column) moveIssuesToAnotherColumn(ctx context.Context, newColumn *Column) error { if c.ProjectID != newColumn.ProjectID { return errors.New("columns have to be in the same project") diff --git a/models/project/project.go b/models/project/project.go index d27e0530947fa..b1e99bcc5c274 100644 --- a/models/project/project.go +++ b/models/project/project.go @@ -46,6 +46,7 @@ const ( type ErrProjectNotExist struct { ID int64 RepoID int64 + Name string } // IsErrProjectNotExist checks if an error is a ErrProjectNotExist @@ -55,6 +56,9 @@ func IsErrProjectNotExist(err error) bool { } func (err ErrProjectNotExist) Error() string { + if err.RepoID > 0 && len(err.Name) > 0 { + return fmt.Sprintf("projects does not exist [repo_id: %d, name: %s]", err.RepoID, err.Name) + } return fmt.Sprintf("projects does not exist [id: %d]", err.ID) } @@ -64,7 +68,9 @@ func (err ErrProjectNotExist) Unwrap() error { // ErrProjectColumnNotExist represents a "ErrProjectColumnNotExist" kind of error. type ErrProjectColumnNotExist struct { - ColumnID int64 + ColumnID int64 + ProjectID int64 + Name string } // IsErrProjectColumnNotExist checks if an error is a ErrProjectColumnNotExist @@ -74,6 +80,9 @@ func IsErrProjectColumnNotExist(err error) bool { } func (err ErrProjectColumnNotExist) Error() string { + if err.ProjectID > 0 && len(err.Name) > 0 { + return fmt.Sprintf("project column does not exist [project_id: %d, name: %s]", err.ProjectID, err.Name) + } return fmt.Sprintf("project column does not exist [id: %d]", err.ColumnID) } @@ -302,6 +311,19 @@ func GetProjectByID(ctx context.Context, id int64) (*Project, error) { return p, nil } +// GetProjectByName returns the projects in a repository +func GetProjectByName(ctx context.Context, repoID int64, name string) (*Project, error) { + p := new(Project) + has, err := db.GetEngine(ctx).Where("repo_id=? AND title=?", repoID, name).Get(p) + if err != nil { + return nil, err + } else if !has { + return nil, ErrProjectNotExist{RepoID: repoID, Name: name} + } + + return p, nil +} + // GetProjectForRepoByID returns the projects in a repository func GetProjectForRepoByID(ctx context.Context, repoID, id int64) (*Project, error) { p := new(Project) diff --git a/models/project/workflows.go b/models/project/workflows.go new file mode 100644 index 0000000000000..0bdb21c334ecf --- /dev/null +++ b/models/project/workflows.go @@ -0,0 +1,120 @@ +// Copyright 2025 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package project + +import ( + "context" + + "code.gitea.io/gitea/models/db" + "code.gitea.io/gitea/modules/timeutil" + "code.gitea.io/gitea/modules/util" +) + +type WorkflowEvent string + +const ( + WorkflowEventItemAddedToProject WorkflowEvent = "item_added_to_project" + WorkflowEventItemReopened WorkflowEvent = "item_reopened" + WorkflowEventItemClosed WorkflowEvent = "item_closed" + WorkflowEventCodeChangesRequested WorkflowEvent = "code_changes_requested" + WorkflowEventCodeReviewApproved WorkflowEvent = "code_review_approved" + WorkflowEventPullRequestMerged WorkflowEvent = "pull_request_merged" + WorkflowEventAutoArchiveItems WorkflowEvent = "auto_archive_items" + WorkflowEventAutoAddToProject WorkflowEvent = "auto_add_to_project" + WorkflowEventAutoCloseIssue WorkflowEvent = "auto_close_issue" +) + +type WorkflowActionType string + +const ( + WorkflowActionTypeScope WorkflowActionType = "scope" // issue, pull_request, etc. + WorkflowActionTypeLabel WorkflowActionType = "label" // choose one or more labels + WorkflowActionTypeColumn WorkflowActionType = "column" // choose one column + WorkflowActionTypeClose WorkflowActionType = "close" // close the issue +) + +type WorkflowAction struct { + ActionType WorkflowActionType + ActionValue string +} + +type ProjectWorkflow struct { + ID int64 + ProjectID int64 `xorm:"unique(s)"` + WorkflowEvent WorkflowEvent `xorm:"unique(s)"` + WorkflowActions []WorkflowAction `xorm:"TEXT json"` + CreatedUnix timeutil.TimeStamp `xorm:"created"` + UpdatedUnix timeutil.TimeStamp `xorm:"updated"` +} + +func (p *ProjectWorkflow) Link() string { + return "" +} + +func newDefaultWorkflows() []*ProjectWorkflow { + return []*ProjectWorkflow{ + { + WorkflowEvent: WorkflowEventItemAddedToProject, + WorkflowActions: []WorkflowAction{{ActionType: WorkflowActionTypeScope, ActionValue: "issue"}}, + }, + { + ProjectID: 0, + WorkflowEvent: WorkflowEventItemReopened, + WorkflowActions: []WorkflowAction{{ActionType: WorkflowActionTypeScope, ActionValue: "issue"}}, + }, + } +} + +func GetWorkflowDefaultValue(workflowIDStr string) *ProjectWorkflow { + workflows := newDefaultWorkflows() + for _, workflow := range workflows { + if workflow.WorkflowEvent == WorkflowEvent(workflowIDStr) { + return workflow + } + } + return &ProjectWorkflow{} +} + +func init() { + db.RegisterModel(new(ProjectWorkflow)) +} + +func FindWorkflowEvents(ctx context.Context, projectID int64) (map[WorkflowEvent]ProjectWorkflow, error) { + events := make(map[WorkflowEvent]ProjectWorkflow) + if err := db.GetEngine(ctx).Where("project_id=?", projectID).Find(&events); err != nil { + return nil, err + } + res := make(map[WorkflowEvent]ProjectWorkflow, len(events)) + for _, event := range events { + res[event.WorkflowEvent] = event + } + return res, nil +} + +func GetWorkflowByID(ctx context.Context, id int64) (*ProjectWorkflow, error) { + p, exist, err := db.GetByID[ProjectWorkflow](ctx, id) + if err != nil { + return nil, err + } + if !exist { + return nil, util.ErrNotExist + } + return p, nil +} + +func GetWorkflows(ctx context.Context, projectID int64) ([]*ProjectWorkflow, error) { + events := make([]*ProjectWorkflow, 0, 10) + if err := db.GetEngine(ctx).Where("project_id=?", projectID).Find(&events); err != nil { + return nil, err + } + workflows := newDefaultWorkflows() + for i, defaultWorkflow := range workflows { + for _, workflow := range events { + if workflow.WorkflowEvent == defaultWorkflow.WorkflowEvent { + workflows[i] = workflow + } + } + } + return workflows, nil +} diff --git a/modules/projects/workflow.go b/modules/projects/workflow.go new file mode 100644 index 0000000000000..0127b1295986e --- /dev/null +++ b/modules/projects/workflow.go @@ -0,0 +1,47 @@ +// Copyright 2024 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +// Action represents an action that can be taken in a workflow +type Action struct { + SetValue string +} + +const ( + // Project workflow event names + EventItemAddedToProject = "item_added_to_project" + EventItemClosed = "item_closed" + EventItem +) + +type Event struct { + Name string + Types []string + Actions []Action +} + +type Workflow struct { + Name string + Events []Event + ProjectID int64 +} + +func ParseWorkflow(content string) (*Workflow, error) { + return &Workflow{}, nil +} + +func (w *Workflow) FireAction(evtName string, f func(action Action) error) error { + for _, evt := range w.Events { + if evt.Name == evtName { + for _, action := range evt.Actions { + // Do something with action + if err := f(action); err != nil { + return err + } + } + break + } + } + return nil +} diff --git a/modules/projects/workflow_test.go b/modules/projects/workflow_test.go new file mode 100644 index 0000000000000..17147335dd158 --- /dev/null +++ b/modules/projects/workflow_test.go @@ -0,0 +1,46 @@ +// Copyright 2024 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestParseWorkflow(t *testing.T) { + workflowFile := ` +name: Test Workflow +on: + item_added_to_project: + types: [issue, pull_request] + action: + - set_value: "status=Todo" + + item_closed: + types: [issue, pull_request] + action: + - remove_label: "" + + item_reopened: + action: + + code_changes_requested: + action: + + code_review_approved: + action: + + pull_request_merged: + action: + + auto_add_to_project: + action: +` + + wf, err := ParseWorkflow(workflowFile) + assert.NoError(t, err) + + assert.Equal(t, "Test Workflow", wf.Name) +} diff --git a/routers/web/projects/workflows.go b/routers/web/projects/workflows.go new file mode 100644 index 0000000000000..60a9e09952f2a --- /dev/null +++ b/routers/web/projects/workflows.go @@ -0,0 +1,73 @@ +// Copyright 2025 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +import ( + "strconv" + + project_model "code.gitea.io/gitea/models/project" + "code.gitea.io/gitea/modules/templates" + "code.gitea.io/gitea/services/context" +) + +var tmplWorkflows = templates.TplName("projects/workflows") + +func Workflows(ctx *context.Context) { + projectID := ctx.PathParamInt64("id") + p, err := project_model.GetProjectByID(ctx, projectID) + if err != nil { + if project_model.IsErrProjectNotExist(err) { + ctx.NotFound(nil) + } else { + ctx.ServerError("GetProjectByID", err) + } + return + } + if p.RepoID != ctx.Repo.Repository.ID { + ctx.NotFound(nil) + return + } + + ctx.Data["Title"] = ctx.Tr("projects.workflows") + ctx.Data["PageIsWorkflows"] = true + ctx.Data["PageIsProjects"] = true + ctx.Data["PageIsProjectsWorkflows"] = true + + workflows, err := project_model.GetWorkflows(ctx, projectID) + if err != nil { + ctx.ServerError("GetWorkflows", err) + return + } + ctx.Data["Workflows"] = workflows + + workflowIDStr := ctx.PathParam("workflow_id") + var workflow *project_model.ProjectWorkflow + if workflowIDStr == "" { // get first value workflow or the first workflow + for _, wf := range workflows { + if wf.ID > 0 { + workflow = wf + break + } + } + if workflow.ID == 0 { + workflow = workflows[0] + } + } else { + workflowID, _ := strconv.ParseInt(workflowIDStr, 10, 64) + if workflowID > 0 { + var err error + workflow, err = project_model.GetWorkflowByID(ctx, workflowID) + if err != nil { + ctx.ServerError("GetWorkflowByID", err) + return + } + ctx.Data["CurWorkflow"] = workflow + } else { + workflow = project_model.GetWorkflowDefaultValue(workflowIDStr) + } + } + ctx.Data["CurWorkflow"] = workflow + + ctx.HTML(200, tmplWorkflows) +} diff --git a/routers/web/web.go b/routers/web/web.go index 5eba29c601219..83ce7f571311e 100644 --- a/routers/web/web.go +++ b/routers/web/web.go @@ -34,6 +34,7 @@ import ( "code.gitea.io/gitea/routers/web/misc" "code.gitea.io/gitea/routers/web/org" org_setting "code.gitea.io/gitea/routers/web/org/setting" + "code.gitea.io/gitea/routers/web/projects" "code.gitea.io/gitea/routers/web/repo" "code.gitea.io/gitea/routers/web/repo/actions" repo_setting "code.gitea.io/gitea/routers/web/repo/setting" @@ -1403,6 +1404,10 @@ func registerWebRoutes(m *web.Router) { m.Group("/{username}/{reponame}/projects", func() { m.Get("", repo.Projects) m.Get("/{id}", repo.ViewProject) + m.Group("/{id}/workflows", func() { + m.Get("", projects.Workflows) + m.Get("/{workflow_id}", projects.Workflows) + }) m.Group("", func() { //nolint:dupl m.Get("/new", repo.RenderNewProject) m.Post("/new", web.Bind(forms.CreateProjectForm{}), repo.NewProjectPost) diff --git a/services/projects/issue.go b/services/projects/issue.go index 590fe960d5329..0c8cd610adfe2 100644 --- a/services/projects/issue.go +++ b/services/projects/issue.go @@ -1,7 +1,7 @@ // Copyright 2024 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT -package project +package projects import ( "context" diff --git a/services/projects/issue_test.go b/services/projects/issue_test.go index e76d31e7574bc..f146999127be0 100644 --- a/services/projects/issue_test.go +++ b/services/projects/issue_test.go @@ -1,7 +1,7 @@ // Copyright 2025 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT -package project +package projects import ( "testing" diff --git a/services/projects/main_test.go b/services/projects/main_test.go index d39c82a140e5e..901f2eba0cc93 100644 --- a/services/projects/main_test.go +++ b/services/projects/main_test.go @@ -1,7 +1,7 @@ // Copyright 2025 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT -package project +package projects import ( "testing" diff --git a/services/projects/workflow_notifier.go b/services/projects/workflow_notifier.go new file mode 100644 index 0000000000000..0b5b4d283e2dd --- /dev/null +++ b/services/projects/workflow_notifier.go @@ -0,0 +1,154 @@ +// Copyright 2024 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +import ( + "context" + "strings" + + issues_model "code.gitea.io/gitea/models/issues" + project_model "code.gitea.io/gitea/models/project" + repo_model "code.gitea.io/gitea/models/repo" + user_model "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/git" + "code.gitea.io/gitea/modules/gitrepo" + "code.gitea.io/gitea/modules/log" + project_module "code.gitea.io/gitea/modules/projects" + notify_service "code.gitea.io/gitea/services/notify" +) + +func init() { + notify_service.RegisterNotifier(&workflowNotifier{}) +} + +type workflowNotifier struct { + notify_service.NullNotifier +} + +var _ notify_service.Notifier = &workflowNotifier{} + +// NewNotifier create a new workflowNotifier notifier +func NewNotifier() notify_service.Notifier { + return &workflowNotifier{} +} + +func findRepoProjectsWorkflows(ctx context.Context, repo *repo_model.Repository) ([]*project_module.Workflow, error) { + gitRepo, err := gitrepo.OpenRepository(ctx, repo) + if err != nil { + log.Error("IssueChangeStatus: OpenRepository: %v", err) + return nil, err + } + defer gitRepo.Close() + + // Get the commit object for the ref + commit, err := gitRepo.GetCommit(repo.DefaultBranch) + if err != nil { + log.Error("gitRepo.GetCommit: %w", err) + return nil, err + } + + tree, err := commit.SubTree(".gitea/projects") + if _, ok := err.(git.ErrNotExist); ok { + return nil, nil + } + if err != nil { + log.Error("commit.SubTree: %w", err) + return nil, err + } + + entries, err := tree.ListEntriesRecursiveFast() + if err != nil { + log.Error("tree.ListEntriesRecursiveFast: %w", err) + return nil, err + } + + ret := make(git.Entries, 0, len(entries)) + for _, entry := range entries { + if strings.HasSuffix(entry.Name(), ".yml") || strings.HasSuffix(entry.Name(), ".yaml") { + ret = append(ret, entry) + } + } + if len(ret) == 0 { + return nil, nil + } + + wfs := make([]*project_module.Workflow, 0, len(ret)) + for _, entry := range ret { + workflowContent, err := commit.GetFileContent(".gitea/projects/"+entry.Name(), 1024*1024) + if err != nil { + log.Error("gitRepo.GetCommit: %w", err) + return nil, err + } + + wf, err := project_module.ParseWorkflow(workflowContent) + if err != nil { + log.Error("IssueChangeStatus: OpenRepository: %v", err) + return nil, err + } + projectName := strings.TrimSuffix(strings.TrimSuffix(entry.Name(), ".yml"), ".yaml") + project, err := project_model.GetProjectByName(ctx, repo.ID, projectName) + if err != nil { + log.Error("IssueChangeStatus: GetProjectByName: %v", err) + return nil, err + } + wf.ProjectID = project.ID + + wfs = append(wfs, wf) + } + return wfs, nil +} + +func (m *workflowNotifier) NewIssue(ctx context.Context, issue *issues_model.Issue, mentions []*user_model.User) { + if err := issue.LoadRepo(ctx); err != nil { + log.Error("NewIssue: LoadRepo: %v", err) + return + } + wfs, err := findRepoProjectsWorkflows(ctx, issue.Repo) + if err != nil { + log.Error("NewIssue: findRepoProjectsWorkflows: %v", err) + return + } + + for _, wf := range wfs { + if err := wf.FireAction(project_module.EventItemClosed, func(action project_module.Action) error { + board, err := project_model.GetColumnByProjectIDAndColumnName(ctx, wf.ProjectID, action.SetValue) + if err != nil { + log.Error("NewIssue: GetBoardByProjectIDAndBoardName: %v", err) + return err + } + return project_model.AddIssueToColumn(ctx, issue.ID, board) + }); err != nil { + log.Error("NewIssue: FireAction: %v", err) + return + } + } +} + +func (m *workflowNotifier) IssueChangeStatus(ctx context.Context, doer *user_model.User, commitID string, issue *issues_model.Issue, actionComment *issues_model.Comment, isClosed bool) { + if isClosed { + if err := issue.LoadRepo(ctx); err != nil { + log.Error("IssueChangeStatus: LoadRepo: %v", err) + return + } + wfs, err := findRepoProjectsWorkflows(ctx, issue.Repo) + if err != nil { + log.Error("IssueChangeStatus: findRepoProjectsWorkflows: %v", err) + return + } + + for _, wf := range wfs { + if err := wf.FireAction(project_module.EventItemClosed, func(action project_module.Action) error { + board, err := project_model.GetColumnByProjectIDAndColumnName(ctx, wf.ProjectID, action.SetValue) + if err != nil { + log.Error("IssueChangeStatus: GetBoardByProjectIDAndBoardName: %v", err) + return err + } + return project_model.MoveIssueToAnotherColumn(ctx, issue.ID, board) + }); err != nil { + log.Error("IssueChangeStatus: FireAction: %v", err) + return + } + } + } +} diff --git a/templates/projects/workflows.tmpl b/templates/projects/workflows.tmpl new file mode 100644 index 0000000000000..b7799316ff15e --- /dev/null +++ b/templates/projects/workflows.tmpl @@ -0,0 +1,11 @@ +
+
+
+
+ {{range .Workflows}} + {{.Name}} + {{end}} +
+
+
+