You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

task_list.go 2.5KB

Implement actions (#21937) Close #13539. Co-authored by: @lunny @appleboy @fuxiaohei and others. Related projects: - https://gitea.com/gitea/actions-proto-def - https://gitea.com/gitea/actions-proto-go - https://gitea.com/gitea/act - https://gitea.com/gitea/act_runner ### Summary The target of this PR is to bring a basic implementation of "Actions", an internal CI/CD system of Gitea. That means even though it has been merged, the state of the feature is **EXPERIMENTAL**, and please note that: - It is disabled by default; - It shouldn't be used in a production environment currently; - It shouldn't be used in a public Gitea instance currently; - Breaking changes may be made before it's stable. **Please comment on #13539 if you have any different product design ideas**, all decisions reached there will be adopted here. But in this PR, we don't talk about **naming, feature-creep or alternatives**. ### ⚠️ Breaking `gitea-actions` will become a reserved user name. If a user with the name already exists in the database, it is recommended to rename it. ### Some important reviews - What is `DEFAULT_ACTIONS_URL` in `app.ini` for? - https://github.com/go-gitea/gitea/pull/21937#discussion_r1055954954 - Why the api for runners is not under the normal `/api/v1` prefix? - https://github.com/go-gitea/gitea/pull/21937#discussion_r1061173592 - Why DBFS? - https://github.com/go-gitea/gitea/pull/21937#discussion_r1061301178 - Why ignore events triggered by `gitea-actions` bot? - https://github.com/go-gitea/gitea/pull/21937#discussion_r1063254103 - Why there's no permission control for actions? - https://github.com/go-gitea/gitea/pull/21937#discussion_r1090229868 ### What it looks like <details> #### Manage runners <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205870657-c72f590e-2e08-4cd4-be7f-2e0abb299bbf.png"> #### List runs <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205872794-50fde990-2b45-48c1-a178-908e4ec5b627.png"> #### View logs <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205872501-9b7b9000-9542-4991-8f55-18ccdada77c3.png"> </details> ### How to try it <details> #### 1. Start Gitea Clone this branch and [install from source](https://docs.gitea.io/en-us/install-from-source). Add additional configurations in `app.ini` to enable Actions: ```ini [actions] ENABLED = true ``` Start it. If all is well, you'll see the management page of runners: <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205877365-8e30a780-9b10-4154-b3e8-ee6c3cb35a59.png"> #### 2. Start runner Clone the [act_runner](https://gitea.com/gitea/act_runner), and follow the [README](https://gitea.com/gitea/act_runner/src/branch/main/README.md) to start it. If all is well, you'll see a new runner has been added: <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205878000-216f5937-e696-470d-b66c-8473987d91c3.png"> #### 3. Enable actions for a repo Create a new repo or open an existing one, check the `Actions` checkbox in settings and submit. <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205879705-53e09208-73c0-4b3e-a123-2dcf9aba4b9c.png"> <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205879383-23f3d08f-1a85-41dd-a8b3-54e2ee6453e8.png"> If all is well, you'll see a new tab "Actions": <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205881648-a8072d8c-5803-4d76-b8a8-9b2fb49516c1.png"> #### 4. Upload workflow files Upload some workflow files to `.gitea/workflows/xxx.yaml`, you can follow the [quickstart](https://docs.github.com/en/actions/quickstart) of GitHub Actions. Yes, Gitea Actions is compatible with GitHub Actions in most cases, you can use the same demo: ```yaml name: GitHub Actions Demo run-name: ${{ github.actor }} is testing out GitHub Actions 🚀 on: [push] jobs: Explore-GitHub-Actions: runs-on: ubuntu-latest steps: - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event." - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!" - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}." - name: Check out repository code uses: actions/checkout@v3 - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner." - run: echo "🖥️ The workflow is now ready to test your code on the runner." - name: List files in the repository run: | ls ${{ github.workspace }} - run: echo "🍏 This job's status is ${{ job.status }}." ``` If all is well, you'll see a new run in `Actions` tab: <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205884473-79a874bc-171b-4aaf-acd5-0241a45c3b53.png"> #### 5. Check the logs of jobs Click a run and you'll see the logs: <img width="1792" alt="image" src="https://user-images.githubusercontent.com/9418365/205884800-994b0374-67f7-48ff-be9a-4c53f3141547.png"> #### 6. Go on You can try more examples in [the documents](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) of GitHub Actions, then you might find a lot of bugs. Come on, PRs are welcome. </details> See also: [Feature Preview: Gitea Actions](https://blog.gitea.io/2022/12/feature-preview-gitea-actions/) --------- Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: ChristopherHX <christopher.homberger@web.de> Co-authored-by: John Olheiser <john.olheiser@gmail.com>
1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. // Copyright 2022 The Gitea Authors. All rights reserved.
  2. // SPDX-License-Identifier: MIT
  3. package actions
  4. import (
  5. "context"
  6. "code.gitea.io/gitea/models/db"
  7. "code.gitea.io/gitea/modules/container"
  8. "code.gitea.io/gitea/modules/timeutil"
  9. "xorm.io/builder"
  10. )
  11. type TaskList []*ActionTask
  12. func (tasks TaskList) GetJobIDs() []int64 {
  13. ids := make(container.Set[int64], len(tasks))
  14. for _, t := range tasks {
  15. if t.JobID == 0 {
  16. continue
  17. }
  18. ids.Add(t.JobID)
  19. }
  20. return ids.Values()
  21. }
  22. func (tasks TaskList) LoadJobs(ctx context.Context) error {
  23. jobIDs := tasks.GetJobIDs()
  24. jobs := make(map[int64]*ActionRunJob, len(jobIDs))
  25. if err := db.GetEngine(ctx).In("id", jobIDs).Find(&jobs); err != nil {
  26. return err
  27. }
  28. for _, t := range tasks {
  29. if t.JobID > 0 && t.Job == nil {
  30. t.Job = jobs[t.JobID]
  31. }
  32. }
  33. // TODO: Replace with "ActionJobList(maps.Values(jobs))" once available
  34. var jobsList ActionJobList = make([]*ActionRunJob, 0, len(jobs))
  35. for _, j := range jobs {
  36. jobsList = append(jobsList, j)
  37. }
  38. return jobsList.LoadAttributes(ctx, true)
  39. }
  40. func (tasks TaskList) LoadAttributes(ctx context.Context) error {
  41. return tasks.LoadJobs(ctx)
  42. }
  43. type FindTaskOptions struct {
  44. db.ListOptions
  45. RepoID int64
  46. OwnerID int64
  47. CommitSHA string
  48. Status Status
  49. UpdatedBefore timeutil.TimeStamp
  50. StartedBefore timeutil.TimeStamp
  51. RunnerID int64
  52. IDOrderDesc bool
  53. }
  54. func (opts FindTaskOptions) toConds() builder.Cond {
  55. cond := builder.NewCond()
  56. if opts.RepoID > 0 {
  57. cond = cond.And(builder.Eq{"repo_id": opts.RepoID})
  58. }
  59. if opts.OwnerID > 0 {
  60. cond = cond.And(builder.Eq{"owner_id": opts.OwnerID})
  61. }
  62. if opts.CommitSHA != "" {
  63. cond = cond.And(builder.Eq{"commit_sha": opts.CommitSHA})
  64. }
  65. if opts.Status > StatusUnknown {
  66. cond = cond.And(builder.Eq{"status": opts.Status})
  67. }
  68. if opts.UpdatedBefore > 0 {
  69. cond = cond.And(builder.Lt{"updated": opts.UpdatedBefore})
  70. }
  71. if opts.StartedBefore > 0 {
  72. cond = cond.And(builder.Lt{"started": opts.StartedBefore})
  73. }
  74. if opts.RunnerID > 0 {
  75. cond = cond.And(builder.Eq{"runner_id": opts.RunnerID})
  76. }
  77. return cond
  78. }
  79. func FindTasks(ctx context.Context, opts FindTaskOptions) (TaskList, error) {
  80. e := db.GetEngine(ctx).Where(opts.toConds())
  81. if opts.PageSize > 0 && opts.Page >= 1 {
  82. e.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize)
  83. }
  84. if opts.IDOrderDesc {
  85. e.OrderBy("id DESC")
  86. }
  87. var tasks TaskList
  88. return tasks, e.Find(&tasks)
  89. }
  90. func CountTasks(ctx context.Context, opts FindTaskOptions) (int64, error) {
  91. return db.GetEngine(ctx).Where(opts.toConds()).Count(new(ActionTask))
  92. }