Skip to content

Commit 4011821

Browse files
wolfogrea1012112796lunnydelvhChristopherHX
authored
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? - #21937 (comment) - Why the api for runners is not under the normal `/api/v1` prefix? - #21937 (comment) - Why DBFS? - #21937 (comment) - Why ignore events triggered by `gitea-actions` bot? - #21937 (comment) - Why there's no permission control for actions? - #21937 (comment) ### 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 <[email protected]> Co-authored-by: Lunny Xiao <[email protected]> Co-authored-by: delvh <[email protected]> Co-authored-by: ChristopherHX <[email protected]> Co-authored-by: John Olheiser <[email protected]>
1 parent b5b3e07 commit 4011821

File tree

117 files changed

+7539
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+7539
-122
lines changed

‎assets/go-licenses.json‎

Lines changed: 120 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cmd/hook.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ Gitea or set your environment appropriately.`, "")
185185
userID, _ := strconv.ParseInt(os.Getenv(repo_module.EnvPusherID), 10, 64)
186186
prID, _ := strconv.ParseInt(os.Getenv(repo_module.EnvPRID), 10, 64)
187187
deployKeyID, _ := strconv.ParseInt(os.Getenv(repo_module.EnvDeployKeyID), 10, 64)
188+
actionPerm, _ := strconv.ParseInt(os.Getenv(repo_module.EnvActionPerm), 10, 64)
188189

189190
hookOptions := private.HookOptions{
190191
UserID: userID,
@@ -194,6 +195,7 @@ Gitea or set your environment appropriately.`, "")
194195
GitPushOptions: pushOptions(),
195196
PullRequestID: prID,
196197
DeployKeyID: deployKeyID,
198+
ActionPerm: int(actionPerm),
197199
}
198200

199201
scanner := bufio.NewScanner(os.Stdin)

‎custom/conf/app.example.ini‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2550,3 +2550,19 @@ ROUTER = console
25502550
;PROXY_URL =
25512551
;; Comma separated list of host names requiring proxy. Glob patterns (*) are accepted; use ** to match all hosts.
25522552
;PROXY_HOSTS =
2553+
2554+
; [actions]
2555+
;; Enable/Disable actions capabilities
2556+
;ENABLED = false
2557+
;; Default address to get action plugins, e.g. the default value means downloading from "https://gitea.com/actions/checkout" for "uses: actions/checkout@v3"
2558+
;DEFAULT_ACTIONS_URL = https://gitea.com
2559+
2560+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2561+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2562+
;; settings for action logs, will override storage setting
2563+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2564+
;[storage.actions_log]
2565+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2566+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2567+
;; storage type
2568+
;STORAGE_TYPE = local

‎docs/content/doc/advanced/config-cheat-sheet.en-us.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,6 +1314,41 @@ PROXY_URL = socks://127.0.0.1:1080
13141314
PROXY_HOSTS = *.github.com
13151315
```
13161316

1317+
## Actions (`actions`)
1318+
1319+
- `ENABLED`: **false**: Enable/Disable actions capabilities
1320+
- `DEFAULT_ACTIONS_URL`: **https://gitea.com**: Default address to get action plugins, e.g. the default value means downloading from "https://gitea.com/actions/checkout" for "uses: actions/checkout@v3"
1321+
1322+
`DEFAULT_ACTIONS_URL` indicates where should we find the relative path action plugin. i.e. when use an action in a workflow file like
1323+
1324+
```yaml
1325+
name: versions
1326+
on:
1327+
push:
1328+
branches:
1329+
- main
1330+
- releases/*
1331+
jobs:
1332+
build:
1333+
runs-on: ubuntu-latest
1334+
steps:
1335+
- uses: actions/checkout@v3
1336+
```
1337+
1338+
Now we need to know how to get actions/checkout, this configuration is the default git server to get it. That means we will get the repository via git clone ${DEFAULT_ACTIONS_URL}/actions/checkout and fetch tag v3.
1339+
1340+
To help people who don't want to mirror these actions in their git instances, the default value is https://gitea.com
1341+
To help people run actions totally in their network, they can change the value and copy all necessary action repositories into their git server.
1342+
1343+
Of course we should support the form in future PRs like
1344+
1345+
```yaml
1346+
steps:
1347+
- uses: gitea.com/actions/checkout@v3
1348+
```
1349+
1350+
although Github don't support this form.
1351+
13171352
## Other (`other`)
13181353

13191354
- `SHOW_FOOTER_BRANDING`: **false**: Show Gitea branding in the footer.

‎docs/content/doc/features/comparison.en-us.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ _Symbols used in table:_
5656
| Deploy Tokens | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
5757
| Repository Tokens with write rights | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ |
5858
| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ |
59-
| Built-in CI/CD | [✘](https://github.com/go-gitea/gitea/issues/13539) | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
59+
| Built-in CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
6060
| Subgroups: groups within groups | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ |
6161
| Interaction with other instances | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ |
6262
| Mermaid diagrams in Markdown | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |

‎docs/content/doc/features/comparison.zh-cn.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ _表格中的符号含义:_
4949
| 内置容器 Registry | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
5050
| 外部 Git 镜像 | ✓ | ✓ | ✘ | ✘ | ✓ | ✓ | ✓ |
5151
| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? |
52-
| 内置 CI/CD | ✘ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
52+
| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
5353
| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ |
5454

5555
#### 代码管理

‎docs/content/doc/features/comparison.zh-tw.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ menu:
5151
| 內建 Container Registry | [✘](https://github.com/go-gitea/gitea/issues/2316) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ |
5252
| 對外部 Git 鏡像 | ✓ | ✓ | ✘ | ✘ | ✓ | ✓ | ✓ |
5353
| FIDO (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ |
54-
| 內建 CI/CD | ✘ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
54+
| 內建 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
5555
| 子群組: 群組中的群組 | ✘ | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ |
5656

5757
## 程式碼管理

‎go.mod‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ module code.gitea.io/gitea
33
go 1.18
44

55
require (
6+
code.gitea.io/actions-proto-go v0.2.0
67
code.gitea.io/gitea-vet v0.2.2
78
code.gitea.io/sdk/gitea v0.15.1
89
codeberg.org/gusted/mcaptcha v0.0.0-20220723083913-4f3072e1d570
@@ -17,6 +18,7 @@ require (
1718
github.com/PuerkitoBio/goquery v1.8.0
1819
github.com/alecthomas/chroma/v2 v2.4.0
1920
github.com/blevesearch/bleve/v2 v2.3.6
21+
github.com/bufbuild/connect-go v1.3.1
2022
github.com/buildkite/terminal-to-html/v3 v3.7.0
2123
github.com/caddyserver/certmagic v0.17.2
2224
github.com/chi-middleware/proxy v1.1.1
@@ -74,6 +76,7 @@ require (
7476
github.com/microcosm-cc/bluemonday v1.0.21
7577
github.com/minio/minio-go/v7 v7.0.46
7678
github.com/msteinert/pam v1.1.0
79+
github.com/nektos/act v0.0.0
7780
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646
7881
github.com/niklasfasching/go-org v1.6.5
7982
github.com/oliamb/cutter v0.2.2
@@ -102,6 +105,8 @@ require (
102105
golang.org/x/sys v0.3.0
103106
golang.org/x/text v0.5.0
104107
golang.org/x/tools v0.1.12
108+
google.golang.org/grpc v1.47.0
109+
google.golang.org/protobuf v1.28.1
105110
gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df
106111
gopkg.in/ini.v1 v1.67.0
107112
gopkg.in/yaml.v3 v3.0.1
@@ -158,12 +163,14 @@ require (
158163
github.com/dlclark/regexp2 v1.7.0 // indirect
159164
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
160165
github.com/emersion/go-sasl v0.0.0-20200509203442-7bfe0ed36a21 // indirect
166+
github.com/fatih/color v1.13.0 // indirect
161167
github.com/felixge/httpsnoop v1.0.3 // indirect
162168
github.com/fxamacker/cbor/v2 v2.4.0 // indirect
163169
github.com/go-ap/errors v0.0.0-20221205040414-01c1adfc98ea // indirect
164170
github.com/go-asn1-ber/asn1-ber v1.5.4 // indirect
165171
github.com/go-enry/go-oniguruma v1.2.1 // indirect
166172
github.com/go-git/gcfg v1.5.0 // indirect
173+
github.com/go-ini/ini v1.67.0 // indirect
167174
github.com/go-openapi/analysis v0.21.4 // indirect
168175
github.com/go-openapi/errors v0.20.3 // indirect
169176
github.com/go-openapi/inflect v0.19.0 // indirect
@@ -205,6 +212,7 @@ require (
205212
github.com/magiconair/properties v1.8.6 // indirect
206213
github.com/mailru/easyjson v0.7.7 // indirect
207214
github.com/markbates/going v1.0.0 // indirect
215+
github.com/mattn/go-colorable v0.1.13 // indirect
208216
github.com/mattn/go-runewidth v0.0.14 // indirect
209217
github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
210218
github.com/mholt/acmez v1.0.4 // indirect
@@ -229,7 +237,9 @@ require (
229237
github.com/prometheus/client_model v0.3.0 // indirect
230238
github.com/prometheus/common v0.37.0 // indirect
231239
github.com/prometheus/procfs v0.8.0 // indirect
240+
github.com/rhysd/actionlint v1.6.22 // indirect
232241
github.com/rivo/uniseg v0.4.3 // indirect
242+
github.com/robfig/cron v1.2.0 // indirect
233243
github.com/rogpeppe/go-internal v1.9.0 // indirect
234244
github.com/rs/xid v1.4.0 // indirect
235245
github.com/russross/blackfriday/v2 v2.1.0 // indirect
@@ -259,9 +269,10 @@ require (
259269
go.uber.org/multierr v1.9.0 // indirect
260270
go.uber.org/zap v1.24.0 // indirect
261271
golang.org/x/mod v0.7.0 // indirect
272+
golang.org/x/sync v0.0.0-20220819030929-7fc1605a5dde // indirect
262273
golang.org/x/time v0.3.0 // indirect
263274
google.golang.org/appengine v1.6.7 // indirect
264-
google.golang.org/protobuf v1.28.1 // indirect
275+
google.golang.org/genproto v0.0.0-20220616135557-88e70c0c3a90 // indirect
265276
gopkg.in/alexcesaro/quotedprintable.v3 v3.0.0-20150716171945-2caba252f4dc // indirect
266277
gopkg.in/warnings.v0 v0.1.2 // indirect
267278
gopkg.in/yaml.v2 v2.4.0 // indirect
@@ -273,6 +284,8 @@ replace github.com/shurcooL/vfsgen => github.com/lunny/vfsgen v0.0.0-20220105142
273284

274285
replace github.com/blevesearch/zapx/v15 v15.3.6 => github.com/zeripath/zapx/v15 v15.3.6-alignment-fix
275286

287+
replace github.com/nektos/act => gitea.com/gitea/act v0.234.0
288+
276289
exclude github.com/gofrs/uuid v3.2.0+incompatible
277290

278291
exclude github.com/gofrs/uuid v4.0.0+incompatible

0 commit comments

Comments
 (0)