2014-03-15 06:01:50 -05:00
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2020-01-09 16:34:25 -05:00
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2014-03-15 06:01:50 -05:00
|
|
|
|
2016-03-11 11:56:52 -05:00
|
|
|
package context
|
2014-03-15 06:01:50 -05:00
|
|
|
|
|
|
|
import (
|
2023-08-07 20:22:47 -05:00
|
|
|
"context"
|
2024-02-18 12:39:04 -05:00
|
|
|
"encoding/hex"
|
2024-02-14 16:48:45 -05:00
|
|
|
"fmt"
|
2014-03-22 12:44:02 -05:00
|
|
|
"html/template"
|
2014-04-15 11:27:29 -05:00
|
|
|
"io"
|
2014-03-15 06:01:50 -05:00
|
|
|
"net/http"
|
2018-03-15 16:13:34 -05:00
|
|
|
"net/url"
|
2014-03-22 15:40:09 -05:00
|
|
|
"strings"
|
2014-03-19 08:57:55 -05:00
|
|
|
"time"
|
2014-03-15 06:01:50 -05:00
|
|
|
|
2021-11-09 14:57:58 -05:00
|
|
|
"code.gitea.io/gitea/models/unit"
|
2021-11-24 04:49:20 -05:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2021-01-27 09:56:54 -05:00
|
|
|
mc "code.gitea.io/gitea/modules/cache"
|
Simplify how git repositories are opened (#28937)
## Purpose
This is a refactor toward building an abstraction over managing git
repositories.
Afterwards, it does not matter anymore if they are stored on the local
disk or somewhere remote.
## What this PR changes
We used `git.OpenRepository` everywhere previously.
Now, we should split them into two distinct functions:
Firstly, there are temporary repositories which do not change:
```go
git.OpenRepository(ctx, diskPath)
```
Gitea managed repositories having a record in the database in the
`repository` table are moved into the new package `gitrepo`:
```go
gitrepo.OpenRepository(ctx, repo_model.Repo)
```
Why is `repo_model.Repository` the second parameter instead of file
path?
Because then we can easily adapt our repository storage strategy.
The repositories can be stored locally, however, they could just as well
be stored on a remote server.
## Further changes in other PRs
- A Git Command wrapper on package `gitrepo` could be created. i.e.
`NewCommand(ctx, repo_model.Repository, commands...)`. `git.RunOpts{Dir:
repo.RepoPath()}`, the directory should be empty before invoking this
method and it can be filled in the function only. #28940
- Remove the `RepoPath()`/`WikiPath()` functions to reduce the
possibility of mistakes.
---------
Co-authored-by: delvh <dev.lh@web.de>
2024-01-27 15:09:51 -05:00
|
|
|
"code.gitea.io/gitea/modules/gitrepo"
|
2022-07-23 01:38:03 -05:00
|
|
|
"code.gitea.io/gitea/modules/httpcache"
|
2016-11-10 11:24:48 -05:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2021-01-26 10:36:53 -05:00
|
|
|
"code.gitea.io/gitea/modules/templates"
|
|
|
|
"code.gitea.io/gitea/modules/translation"
|
2023-06-18 02:59:09 -05:00
|
|
|
"code.gitea.io/gitea/modules/web"
|
2021-01-30 03:55:53 -05:00
|
|
|
"code.gitea.io/gitea/modules/web/middleware"
|
2023-06-18 02:59:09 -05:00
|
|
|
web_types "code.gitea.io/gitea/modules/web/types"
|
2019-08-23 11:40:30 -05:00
|
|
|
|
2024-08-26 18:57:40 -05:00
|
|
|
"code.forgejo.org/go-chi/cache"
|
2024-08-22 20:08:06 -05:00
|
|
|
"code.forgejo.org/go-chi/session"
|
2014-03-15 06:01:50 -05:00
|
|
|
)
|
|
|
|
|
2021-01-26 10:36:53 -05:00
|
|
|
// Render represents a template render
|
|
|
|
type Render interface {
|
2023-08-07 20:22:47 -05:00
|
|
|
TemplateLookup(tmpl string, templateCtx context.Context) (templates.TemplateExecutor, error)
|
|
|
|
HTML(w io.Writer, status int, name string, data any, templateCtx context.Context) error
|
2021-01-26 10:36:53 -05:00
|
|
|
}
|
|
|
|
|
2014-03-15 08:17:16 -05:00
|
|
|
// Context represents context of a request.
|
2014-03-15 06:01:50 -05:00
|
|
|
type Context struct {
|
2023-05-20 20:50:53 -05:00
|
|
|
*Base
|
2023-05-08 18:30:14 -05:00
|
|
|
|
2023-08-07 20:22:47 -05:00
|
|
|
TemplateContext TemplateContext
|
|
|
|
|
2023-05-20 20:50:53 -05:00
|
|
|
Render Render
|
|
|
|
PageData map[string]any // data used by JavaScript modules in one page, it's `window.config.pageData`
|
2014-07-25 23:24:27 -05:00
|
|
|
|
2023-05-08 18:30:14 -05:00
|
|
|
Cache cache.Cache
|
|
|
|
Csrf CSRFProtector
|
|
|
|
Flash *middleware.Flash
|
|
|
|
Session session.Store
|
|
|
|
|
2023-05-20 20:50:53 -05:00
|
|
|
Link string // current request URL (without query string)
|
|
|
|
|
|
|
|
Doer *user_model.User // current signed-in user
|
2014-11-18 11:07:16 -05:00
|
|
|
IsSigned bool
|
|
|
|
IsBasicAuth bool
|
2014-03-15 11:03:23 -05:00
|
|
|
|
2023-05-20 20:50:53 -05:00
|
|
|
ContextUser *user_model.User // the user which is being visited, in most cases it differs from Doer
|
2014-03-15 06:01:50 -05:00
|
|
|
|
2023-05-20 20:50:53 -05:00
|
|
|
Repo *Repository
|
|
|
|
Org *Organization
|
|
|
|
Package *Package
|
2022-05-05 09:13:23 -05:00
|
|
|
}
|
|
|
|
|
2023-08-07 20:22:47 -05:00
|
|
|
type TemplateContext map[string]any
|
|
|
|
|
2023-06-18 02:59:09 -05:00
|
|
|
func init() {
|
|
|
|
web.RegisterResponseStatusProvider[*Context](func(req *http.Request) web_types.ResponseStatusProvider {
|
|
|
|
return req.Context().Value(WebContextKey).(*Context)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2023-05-22 20:29:15 -05:00
|
|
|
type webContextKeyType struct{}
|
2021-12-15 01:59:57 -05:00
|
|
|
|
2023-05-22 20:29:15 -05:00
|
|
|
var WebContextKey = webContextKeyType{}
|
2021-01-26 10:36:53 -05:00
|
|
|
|
2023-05-22 20:29:15 -05:00
|
|
|
func GetWebContext(req *http.Request) *Context {
|
|
|
|
ctx, _ := req.Context().Value(WebContextKey).(*Context)
|
2023-05-20 20:50:53 -05:00
|
|
|
return ctx
|
2021-01-26 10:36:53 -05:00
|
|
|
}
|
|
|
|
|
2023-05-20 20:50:53 -05:00
|
|
|
// ValidateContext is a special context for form validation middleware. It may be different from other contexts.
|
|
|
|
type ValidateContext struct {
|
|
|
|
*Base
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetValidateContext gets a context for middleware form validation
|
|
|
|
func GetValidateContext(req *http.Request) (ctx *ValidateContext) {
|
|
|
|
if ctxAPI, ok := req.Context().Value(apiContextKey).(*APIContext); ok {
|
|
|
|
ctx = &ValidateContext{Base: ctxAPI.Base}
|
2023-05-22 20:29:15 -05:00
|
|
|
} else if ctxWeb, ok := req.Context().Value(WebContextKey).(*Context); ok {
|
2023-05-20 20:50:53 -05:00
|
|
|
ctx = &ValidateContext{Base: ctxWeb.Base}
|
|
|
|
} else {
|
|
|
|
panic("invalid context, expect either APIContext or Context")
|
2023-04-13 14:45:33 -05:00
|
|
|
}
|
2023-05-20 20:50:53 -05:00
|
|
|
return ctx
|
2021-01-26 10:36:53 -05:00
|
|
|
}
|
|
|
|
|
2023-08-25 06:07:42 -05:00
|
|
|
func NewTemplateContextForWeb(ctx *Context) TemplateContext {
|
|
|
|
tmplCtx := NewTemplateContext(ctx)
|
|
|
|
tmplCtx["Locale"] = ctx.Base.Locale
|
|
|
|
tmplCtx["AvatarUtils"] = templates.NewAvatarUtils(ctx)
|
|
|
|
return tmplCtx
|
|
|
|
}
|
|
|
|
|
|
|
|
func NewWebContext(base *Base, render Render, session session.Store) *Context {
|
|
|
|
ctx := &Context{
|
|
|
|
Base: base,
|
|
|
|
Render: render,
|
|
|
|
Session: session,
|
|
|
|
|
|
|
|
Cache: mc.GetCache(),
|
|
|
|
Link: setting.AppSubURL + strings.TrimSuffix(base.Req.URL.EscapedPath(), "/"),
|
|
|
|
Repo: &Repository{PullRequest: &PullRequest{}},
|
|
|
|
Org: &Organization{},
|
|
|
|
}
|
|
|
|
ctx.TemplateContext = NewTemplateContextForWeb(ctx)
|
|
|
|
ctx.Flash = &middleware.Flash{DataStore: ctx, Values: url.Values{}}
|
|
|
|
return ctx
|
|
|
|
}
|
|
|
|
|
2023-05-08 04:36:54 -05:00
|
|
|
// Contexter initializes a classic context for a request.
|
|
|
|
func Contexter() func(next http.Handler) http.Handler {
|
|
|
|
rnd := templates.HTMLRenderer()
|
|
|
|
csrfOpts := CsrfOptions{
|
2024-02-18 12:39:04 -05:00
|
|
|
Secret: hex.EncodeToString(setting.GetGeneralTokenSigningSecret()),
|
2021-01-26 10:36:53 -05:00
|
|
|
Cookie: setting.CSRFCookieName,
|
|
|
|
Secure: setting.SessionConfig.Secure,
|
|
|
|
CookieHTTPOnly: setting.CSRFCookieHTTPOnly,
|
|
|
|
CookieDomain: setting.SessionConfig.Domain,
|
|
|
|
CookiePath: setting.SessionConfig.CookiePath,
|
2021-03-07 03:12:43 -05:00
|
|
|
SameSite: setting.SessionConfig.SameSite,
|
2021-01-26 10:36:53 -05:00
|
|
|
}
|
2022-04-08 00:21:05 -05:00
|
|
|
if !setting.IsProd {
|
|
|
|
CsrfTokenRegenerationInterval = 5 * time.Second // in dev, re-generate the tokens more aggressively for debug purpose
|
|
|
|
}
|
2021-01-26 10:36:53 -05:00
|
|
|
return func(next http.Handler) http.Handler {
|
|
|
|
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
|
2023-05-20 20:50:53 -05:00
|
|
|
base, baseCleanUp := NewBaseContext(resp, req)
|
|
|
|
defer baseCleanUp()
|
2023-08-25 06:07:42 -05:00
|
|
|
ctx := NewWebContext(base, rnd, session.GetSession(req))
|
2023-08-07 20:22:47 -05:00
|
|
|
|
2023-05-04 01:36:34 -05:00
|
|
|
ctx.Data.MergeFrom(middleware.CommonTemplateContextData())
|
2023-08-07 20:22:47 -05:00
|
|
|
ctx.Data["Context"] = ctx // TODO: use "ctx" in template and remove this
|
2023-05-04 01:36:34 -05:00
|
|
|
ctx.Data["CurrentURL"] = setting.AppSubURL + req.URL.RequestURI()
|
|
|
|
ctx.Data["Link"] = ctx.Link
|
|
|
|
|
2021-10-14 21:35:26 -05:00
|
|
|
// PageData is passed by reference, and it will be rendered to `window.config.pageData` in `head.tmpl` for JavaScript modules
|
2023-05-04 01:36:34 -05:00
|
|
|
ctx.PageData = map[string]any{}
|
2021-10-12 13:11:35 -05:00
|
|
|
ctx.Data["PageData"] = ctx.PageData
|
2021-01-26 10:36:53 -05:00
|
|
|
|
2023-05-22 20:29:15 -05:00
|
|
|
ctx.Base.AppendContextValue(WebContextKey, ctx)
|
Simplify how git repositories are opened (#28937)
## Purpose
This is a refactor toward building an abstraction over managing git
repositories.
Afterwards, it does not matter anymore if they are stored on the local
disk or somewhere remote.
## What this PR changes
We used `git.OpenRepository` everywhere previously.
Now, we should split them into two distinct functions:
Firstly, there are temporary repositories which do not change:
```go
git.OpenRepository(ctx, diskPath)
```
Gitea managed repositories having a record in the database in the
`repository` table are moved into the new package `gitrepo`:
```go
gitrepo.OpenRepository(ctx, repo_model.Repo)
```
Why is `repo_model.Repository` the second parameter instead of file
path?
Because then we can easily adapt our repository storage strategy.
The repositories can be stored locally, however, they could just as well
be stored on a remote server.
## Further changes in other PRs
- A Git Command wrapper on package `gitrepo` could be created. i.e.
`NewCommand(ctx, repo_model.Repository, commands...)`. `git.RunOpts{Dir:
repo.RepoPath()}`, the directory should be empty before invoking this
method and it can be filled in the function only. #28940
- Remove the `RepoPath()`/`WikiPath()` functions to reduce the
possibility of mistakes.
---------
Co-authored-by: delvh <dev.lh@web.de>
2024-01-27 15:09:51 -05:00
|
|
|
ctx.Base.AppendContextValueFunc(gitrepo.RepositoryContextKey, func() any { return ctx.Repo.GitRepo })
|
2023-05-20 20:50:53 -05:00
|
|
|
|
2024-09-18 02:17:25 -05:00
|
|
|
ctx.Csrf = NewCSRFProtector(csrfOpts)
|
2021-01-26 10:36:53 -05:00
|
|
|
|
2023-04-13 14:45:33 -05:00
|
|
|
// Get the last flash message from cookie
|
|
|
|
lastFlashCookie := middleware.GetSiteCookie(ctx.Req, CookieNameFlash)
|
|
|
|
if vals, _ := url.ParseQuery(lastFlashCookie); len(vals) > 0 {
|
|
|
|
// store last Flash message into the template data, to render it
|
|
|
|
ctx.Data["Flash"] = &middleware.Flash{
|
2023-05-20 20:50:53 -05:00
|
|
|
DataStore: ctx,
|
2021-01-26 10:36:53 -05:00
|
|
|
Values: vals,
|
|
|
|
ErrorMsg: vals.Get("error"),
|
|
|
|
SuccessMsg: vals.Get("success"),
|
|
|
|
InfoMsg: vals.Get("info"),
|
|
|
|
WarningMsg: vals.Get("warning"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-08-25 06:07:42 -05:00
|
|
|
// if there are new messages in the ctx.Flash, write them into cookie
|
2021-01-26 10:36:53 -05:00
|
|
|
ctx.Resp.Before(func(resp ResponseWriter) {
|
2023-04-13 14:45:33 -05:00
|
|
|
if val := ctx.Flash.Encode(); val != "" {
|
|
|
|
middleware.SetSiteCookie(ctx.Resp, CookieNameFlash, val, 0)
|
|
|
|
} else if lastFlashCookie != "" {
|
|
|
|
middleware.SetSiteCookie(ctx.Resp, CookieNameFlash, "", -1)
|
2021-01-26 10:36:53 -05:00
|
|
|
}
|
|
|
|
})
|
|
|
|
|
|
|
|
// If request sends files, parse them here otherwise the Query() can't be parsed and the CsrfToken will be invalid.
|
|
|
|
if ctx.Req.Method == "POST" && strings.Contains(ctx.Req.Header.Get("Content-Type"), "multipart/form-data") {
|
|
|
|
if err := ctx.Req.ParseMultipartForm(setting.Attachment.MaxSize << 20); err != nil && !strings.Contains(err.Error(), "EOF") { // 32MB max size
|
|
|
|
ctx.ServerError("ParseMultipartForm", err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
2018-08-26 21:23:27 -05:00
|
|
|
|
2023-03-08 15:40:04 -05:00
|
|
|
httpcache.SetCacheControlInHeader(ctx.Resp.Header(), 0, "no-transform")
|
2021-08-06 15:47:10 -05:00
|
|
|
ctx.Resp.Header().Set(`X-Frame-Options`, setting.CORSConfig.XFrameOptions)
|
2021-01-26 10:36:53 -05:00
|
|
|
|
2024-02-24 08:12:17 -05:00
|
|
|
ctx.Data["SystemConfig"] = setting.Config()
|
2021-01-26 10:36:53 -05:00
|
|
|
|
2021-05-04 16:48:31 -05:00
|
|
|
// FIXME: do we really always need these setting? There should be someway to have to avoid having to always set these
|
2021-01-26 10:36:53 -05:00
|
|
|
ctx.Data["DisableMigrations"] = setting.Repository.DisableMigrations
|
2021-04-15 11:53:57 -05:00
|
|
|
ctx.Data["DisableStars"] = setting.Repository.DisableStars
|
2024-02-25 05:58:23 -05:00
|
|
|
ctx.Data["DisableForks"] = setting.Repository.DisableForks
|
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
|
|
|
ctx.Data["EnableActions"] = setting.Actions.Enabled
|
2021-01-26 10:36:53 -05:00
|
|
|
|
|
|
|
ctx.Data["ManifestData"] = setting.ManifestData
|
|
|
|
|
2021-11-09 14:57:58 -05:00
|
|
|
ctx.Data["UnitWikiGlobalDisabled"] = unit.TypeWiki.UnitGlobalDisabled()
|
|
|
|
ctx.Data["UnitIssuesGlobalDisabled"] = unit.TypeIssues.UnitGlobalDisabled()
|
|
|
|
ctx.Data["UnitPullsGlobalDisabled"] = unit.TypePullRequests.UnitGlobalDisabled()
|
|
|
|
ctx.Data["UnitProjectsGlobalDisabled"] = unit.TypeProjects.UnitGlobalDisabled()
|
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
|
|
|
ctx.Data["UnitActionsGlobalDisabled"] = unit.TypeActions.UnitGlobalDisabled()
|
2021-05-04 16:48:31 -05:00
|
|
|
|
2021-01-26 10:36:53 -05:00
|
|
|
ctx.Data["AllLangs"] = translation.AllLangs()
|
2020-12-22 06:13:50 -05:00
|
|
|
|
2021-01-26 10:36:53 -05:00
|
|
|
next.ServeHTTP(ctx.Resp, ctx.Req)
|
|
|
|
})
|
2014-03-15 06:01:50 -05:00
|
|
|
}
|
|
|
|
}
|
2023-05-20 20:50:53 -05:00
|
|
|
|
|
|
|
// HasError returns true if error occurs in form validation.
|
|
|
|
// Attention: this function changes ctx.Data and ctx.Flash
|
|
|
|
func (ctx *Context) HasError() bool {
|
|
|
|
hasErr, ok := ctx.Data["HasError"]
|
|
|
|
if !ok {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
ctx.Flash.ErrorMsg = ctx.GetErrMsg()
|
|
|
|
ctx.Data["Flash"] = ctx.Flash
|
|
|
|
return hasErr.(bool)
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetErrMsg returns error message in form validation.
|
|
|
|
func (ctx *Context) GetErrMsg() string {
|
|
|
|
msg, _ := ctx.Data["ErrorMsg"].(string)
|
|
|
|
if msg == "" {
|
|
|
|
msg = "invalid form data"
|
|
|
|
}
|
|
|
|
return msg
|
|
|
|
}
|
2023-07-26 01:04:01 -05:00
|
|
|
|
|
|
|
func (ctx *Context) JSONRedirect(redirect string) {
|
|
|
|
ctx.JSON(http.StatusOK, map[string]any{"redirect": redirect})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (ctx *Context) JSONOK() {
|
|
|
|
ctx.JSON(http.StatusOK, map[string]any{"ok": true}) // this is only a dummy response, frontend seldom uses it
|
|
|
|
}
|
|
|
|
|
2024-02-14 16:48:45 -05:00
|
|
|
func (ctx *Context) JSONError(msg any) {
|
|
|
|
switch v := msg.(type) {
|
|
|
|
case string:
|
|
|
|
ctx.JSON(http.StatusBadRequest, map[string]any{"errorMessage": v, "renderFormat": "text"})
|
|
|
|
case template.HTML:
|
|
|
|
ctx.JSON(http.StatusBadRequest, map[string]any{"errorMessage": v, "renderFormat": "html"})
|
|
|
|
default:
|
|
|
|
panic(fmt.Sprintf("unsupported type: %T", msg))
|
|
|
|
}
|
2023-07-26 01:04:01 -05:00
|
|
|
}
|