mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-25 21:44:20 -04:00
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>
164 lines
4.1 KiB
Go
164 lines
4.1 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package actions
|
|
|
|
import (
|
|
"bufio"
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"strings"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models/dbfs"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/storage"
|
|
|
|
runnerv1 "code.gitea.io/actions-proto-go/runner/v1"
|
|
"google.golang.org/protobuf/types/known/timestamppb"
|
|
)
|
|
|
|
const (
|
|
MaxLineSize = 64 * 1024
|
|
DBFSPrefix = "actions_log/"
|
|
|
|
timeFormat = "2006-01-02T15:04:05.0000000Z07:00"
|
|
defaultBufSize = MaxLineSize
|
|
)
|
|
|
|
func WriteLogs(ctx context.Context, filename string, offset int64, rows []*runnerv1.LogRow) ([]int, error) {
|
|
name := DBFSPrefix + filename
|
|
f, err := dbfs.OpenFile(ctx, name, os.O_WRONLY|os.O_CREATE)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dbfs OpenFile %q: %w", name, err)
|
|
}
|
|
defer f.Close()
|
|
if _, err := f.Seek(offset, io.SeekStart); err != nil {
|
|
return nil, fmt.Errorf("dbfs Seek %q: %w", name, err)
|
|
}
|
|
|
|
writer := bufio.NewWriterSize(f, defaultBufSize)
|
|
|
|
ns := make([]int, 0, len(rows))
|
|
for _, row := range rows {
|
|
n, err := writer.WriteString(FormatLog(row.Time.AsTime(), row.Content) + "\n")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
ns = append(ns, n)
|
|
}
|
|
|
|
if err := writer.Flush(); err != nil {
|
|
return nil, err
|
|
}
|
|
return ns, nil
|
|
}
|
|
|
|
func ReadLogs(ctx context.Context, inStorage bool, filename string, offset, limit int64) ([]*runnerv1.LogRow, error) {
|
|
f, err := openLogs(ctx, inStorage, filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer f.Close()
|
|
|
|
if _, err := f.Seek(offset, io.SeekStart); err != nil {
|
|
return nil, fmt.Errorf("file seek: %w", err)
|
|
}
|
|
|
|
scanner := bufio.NewScanner(f)
|
|
maxLineSize := len(timeFormat) + MaxLineSize + 1
|
|
scanner.Buffer(make([]byte, maxLineSize), maxLineSize)
|
|
|
|
var rows []*runnerv1.LogRow
|
|
for scanner.Scan() && (int64(len(rows)) < limit || limit < 0) {
|
|
t, c, err := ParseLog(scanner.Text())
|
|
if err != nil {
|
|
return nil, fmt.Errorf("parse log %q: %w", scanner.Text(), err)
|
|
}
|
|
rows = append(rows, &runnerv1.LogRow{
|
|
Time: timestamppb.New(t),
|
|
Content: c,
|
|
})
|
|
}
|
|
|
|
if err := scanner.Err(); err != nil {
|
|
return nil, fmt.Errorf("scan: %w", err)
|
|
}
|
|
|
|
return rows, nil
|
|
}
|
|
|
|
func TransferLogs(ctx context.Context, filename string) (func(), error) {
|
|
name := DBFSPrefix + filename
|
|
remove := func() {
|
|
if err := dbfs.Remove(ctx, name); err != nil {
|
|
log.Warn("dbfs remove %q: %v", name, err)
|
|
}
|
|
}
|
|
f, err := dbfs.Open(ctx, name)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dbfs open %q: %w", name, err)
|
|
}
|
|
defer f.Close()
|
|
|
|
if _, err := storage.Actions.Save(filename, f, -1); err != nil {
|
|
return nil, fmt.Errorf("storage save %q: %w", filename, err)
|
|
}
|
|
return remove, nil
|
|
}
|
|
|
|
func RemoveLogs(ctx context.Context, inStorage bool, filename string) error {
|
|
if !inStorage {
|
|
name := DBFSPrefix + filename
|
|
err := dbfs.Remove(ctx, name)
|
|
if err != nil {
|
|
return fmt.Errorf("dbfs remove %q: %w", name, err)
|
|
}
|
|
return nil
|
|
}
|
|
err := storage.Actions.Delete(filename)
|
|
if err != nil {
|
|
return fmt.Errorf("storage delete %q: %w", filename, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func openLogs(ctx context.Context, inStorage bool, filename string) (io.ReadSeekCloser, error) {
|
|
if !inStorage {
|
|
name := DBFSPrefix + filename
|
|
f, err := dbfs.Open(ctx, name)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dbfs open %q: %w", name, err)
|
|
}
|
|
return f, nil
|
|
}
|
|
f, err := storage.Actions.Open(filename)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("storage open %q: %w", filename, err)
|
|
}
|
|
return f, nil
|
|
}
|
|
|
|
func FormatLog(timestamp time.Time, content string) string {
|
|
// Content shouldn't contain new line, it will break log indexes, other control chars are safe.
|
|
content = strings.ReplaceAll(content, "\n", `\n`)
|
|
if len(content) > MaxLineSize {
|
|
content = content[:MaxLineSize]
|
|
}
|
|
return fmt.Sprintf("%s %s", timestamp.UTC().Format(timeFormat), content)
|
|
}
|
|
|
|
func ParseLog(in string) (time.Time, string, error) {
|
|
index := strings.IndexRune(in, ' ')
|
|
if index < 0 {
|
|
return time.Time{}, "", fmt.Errorf("invalid log: %q", in)
|
|
}
|
|
timestamp, err := time.Parse(timeFormat, in[:index])
|
|
if err != nil {
|
|
return time.Time{}, "", err
|
|
}
|
|
return timestamp, in[index+1:], nil
|
|
}
|