2014-04-12 21:30:09 -04:00
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2019-07-15 20:13:03 -04:00
|
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2014-04-12 21:30:09 -04:00
|
|
|
|
|
|
|
package cron
|
|
|
|
|
|
|
|
import (
|
2019-12-15 04:51:28 -05:00
|
|
|
"context"
|
2022-03-31 13:01:43 -04:00
|
|
|
"runtime/pprof"
|
2014-06-13 13:01:52 -04:00
|
|
|
"time"
|
|
|
|
|
2019-12-15 04:51:28 -05:00
|
|
|
"code.gitea.io/gitea/modules/graceful"
|
2022-03-31 13:01:43 -04:00
|
|
|
"code.gitea.io/gitea/modules/process"
|
2019-07-15 20:13:03 -04:00
|
|
|
"code.gitea.io/gitea/modules/sync"
|
2022-06-26 10:19:22 -04:00
|
|
|
"code.gitea.io/gitea/modules/translation"
|
2019-07-15 20:13:03 -04:00
|
|
|
|
2023-07-24 00:13:41 -04:00
|
|
|
"github.com/go-co-op/gocron"
|
2019-07-15 20:13:03 -04:00
|
|
|
)
|
|
|
|
|
2023-07-24 00:13:41 -04:00
|
|
|
var scheduler = gocron.NewScheduler(time.Local)
|
2016-02-20 15:58:09 -05:00
|
|
|
|
2019-07-15 20:13:03 -04:00
|
|
|
// Prevent duplicate running tasks.
|
|
|
|
var taskStatusTable = sync.NewStatusTable()
|
|
|
|
|
2016-11-25 03:19:24 -05:00
|
|
|
// NewContext begins cron tasks
|
2019-12-15 04:51:28 -05:00
|
|
|
// Each cron task is run within the shutdown context as a running server
|
|
|
|
// AtShutdown the cron server is stopped
|
2022-03-31 13:01:43 -04:00
|
|
|
func NewContext(original context.Context) {
|
|
|
|
defer pprof.SetGoroutineLabels(original)
|
|
|
|
_, _, finished := process.GetManager().AddTypedContext(graceful.GetManager().ShutdownContext(), "Service: Cron", process.SystemProcessType, true)
|
2020-05-16 19:31:38 -04:00
|
|
|
initBasicTasks()
|
|
|
|
initExtendedTasks()
|
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>
2023-01-30 20:45:19 -05:00
|
|
|
initActionsTasks()
|
2019-10-14 02:10:42 -04:00
|
|
|
|
2020-05-16 19:31:38 -04:00
|
|
|
lock.Lock()
|
|
|
|
for _, task := range tasks {
|
|
|
|
if task.IsEnabled() && task.DoRunAtStart() {
|
|
|
|
go task.Run()
|
|
|
|
}
|
2019-10-14 02:10:42 -04:00
|
|
|
}
|
|
|
|
|
2023-07-24 00:13:41 -04:00
|
|
|
scheduler.StartAsync()
|
2020-05-16 19:31:38 -04:00
|
|
|
started = true
|
|
|
|
lock.Unlock()
|
|
|
|
graceful.GetManager().RunAtShutdown(context.Background(), func() {
|
2023-07-24 00:13:41 -04:00
|
|
|
scheduler.Stop()
|
2020-05-16 19:31:38 -04:00
|
|
|
lock.Lock()
|
|
|
|
started = false
|
|
|
|
lock.Unlock()
|
2022-03-31 13:01:43 -04:00
|
|
|
finished()
|
2020-05-16 19:31:38 -04:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// TaskTableRow represents a task row in the tasks table
|
|
|
|
type TaskTableRow struct {
|
2022-03-28 21:31:07 -04:00
|
|
|
Name string
|
|
|
|
Spec string
|
|
|
|
Next time.Time
|
|
|
|
Prev time.Time
|
|
|
|
Status string
|
|
|
|
LastMessage string
|
|
|
|
LastDoer string
|
|
|
|
ExecTimes int64
|
|
|
|
task *Task
|
|
|
|
}
|
|
|
|
|
2022-06-26 10:19:22 -04:00
|
|
|
func (t *TaskTableRow) FormatLastMessage(locale translation.Locale) string {
|
2022-03-28 21:31:07 -04:00
|
|
|
if t.Status == "finished" {
|
|
|
|
return t.task.GetConfig().FormatMessage(locale, t.Name, t.Status, t.LastDoer)
|
|
|
|
}
|
|
|
|
|
|
|
|
return t.task.GetConfig().FormatMessage(locale, t.Name, t.Status, t.LastDoer, t.LastMessage)
|
2014-06-13 13:01:52 -04:00
|
|
|
}
|
|
|
|
|
2020-05-16 19:31:38 -04:00
|
|
|
// TaskTable represents a table of tasks
|
|
|
|
type TaskTable []*TaskTableRow
|
|
|
|
|
2016-02-20 15:58:09 -05:00
|
|
|
// ListTasks returns all running cron tasks.
|
2020-05-16 19:31:38 -04:00
|
|
|
func ListTasks() TaskTable {
|
2023-07-24 00:13:41 -04:00
|
|
|
jobs := scheduler.Jobs()
|
|
|
|
jobMap := map[string]*gocron.Job{}
|
|
|
|
for _, job := range jobs {
|
|
|
|
// the first tag is the task name
|
|
|
|
tags := job.Tags()
|
|
|
|
if len(tags) == 0 { // should never happen
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
jobMap[job.Tags()[0]] = job
|
2020-05-16 19:31:38 -04:00
|
|
|
}
|
2023-07-24 00:13:41 -04:00
|
|
|
|
2020-05-16 19:31:38 -04:00
|
|
|
lock.Lock()
|
|
|
|
defer lock.Unlock()
|
2023-07-24 00:13:41 -04:00
|
|
|
|
2020-05-16 19:31:38 -04:00
|
|
|
tTable := make([]*TaskTableRow, 0, len(tasks))
|
|
|
|
for _, task := range tasks {
|
|
|
|
spec := "-"
|
|
|
|
var (
|
|
|
|
next time.Time
|
|
|
|
prev time.Time
|
|
|
|
)
|
2023-07-24 00:13:41 -04:00
|
|
|
if e, ok := jobMap[task.Name]; ok {
|
|
|
|
tags := e.Tags()
|
|
|
|
if len(tags) > 1 {
|
|
|
|
spec = tags[1] // the second tag is the task spec
|
|
|
|
}
|
|
|
|
next = e.NextRun()
|
|
|
|
prev = e.PreviousRun()
|
2020-05-16 19:31:38 -04:00
|
|
|
}
|
2023-10-11 07:26:34 -04:00
|
|
|
|
|
|
|
// If the manual run is after the cron run, use that instead.
|
|
|
|
if prev.Before(task.LastRun) {
|
|
|
|
prev = task.LastRun
|
|
|
|
}
|
|
|
|
|
2020-05-16 19:31:38 -04:00
|
|
|
task.lock.Lock()
|
|
|
|
tTable = append(tTable, &TaskTableRow{
|
2022-03-28 21:31:07 -04:00
|
|
|
Name: task.Name,
|
|
|
|
Spec: spec,
|
|
|
|
Next: next,
|
|
|
|
Prev: prev,
|
|
|
|
ExecTimes: task.ExecTimes,
|
|
|
|
LastMessage: task.LastMessage,
|
|
|
|
Status: task.Status,
|
|
|
|
LastDoer: task.LastDoer,
|
|
|
|
task: task,
|
2020-05-16 19:31:38 -04:00
|
|
|
})
|
|
|
|
task.lock.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
return tTable
|
2014-04-12 21:30:09 -04:00
|
|
|
}
|