2019-05-11 18:29:17 +03:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2019-05-11 18:29:17 +03:00
2022-05-08 19:46:32 +03:00
package repository
2019-05-11 18:29:17 +03:00
import (
"fmt"
"os"
"strings"
2020-09-07 06:53:42 +03:00
2021-12-10 04:27:50 +03:00
repo_model "code.gitea.io/gitea/models/repo"
2021-11-24 12:49:20 +03:00
user_model "code.gitea.io/gitea/models/user"
2020-09-07 06:53:42 +03:00
"code.gitea.io/gitea/modules/setting"
2019-05-11 18:29:17 +03:00
)
2020-02-03 11:47:04 +03:00
// env keys for git hooks need
const (
EnvRepoName = "GITEA_REPO_NAME"
EnvRepoUsername = "GITEA_REPO_USER_NAME"
2020-08-30 10:24:39 +03:00
EnvRepoID = "GITEA_REPO_ID"
2020-02-03 11:47:04 +03:00
EnvRepoIsWiki = "GITEA_REPO_IS_WIKI"
EnvPusherName = "GITEA_PUSHER_NAME"
EnvPusherEmail = "GITEA_PUSHER_EMAIL"
EnvPusherID = "GITEA_PUSHER_ID"
2022-03-22 12:29:07 +03:00
EnvKeyID = "GITEA_KEY_ID" // public key ID
EnvDeployKeyID = "GITEA_DEPLOY_KEY_ID"
2020-08-30 10:24:39 +03:00
EnvPRID = "GITEA_PR_ID"
2024-05-07 10:36:48 +03:00
EnvPushTrigger = "GITEA_PUSH_TRIGGER"
2020-02-03 11:47:04 +03:00
EnvIsInternal = "GITEA_INTERNAL_PUSH"
2020-09-07 06:53:42 +03:00
EnvAppURL = "GITEA_ROOT_URL"
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-31 04:45:19 +03:00
EnvActionPerm = "GITEA_ACTION_PERM"
2020-02-03 11:47:04 +03:00
)
2024-05-07 10:36:48 +03:00
type PushTrigger string
const (
PushTriggerPRMergeToBase PushTrigger = "pr-merge-to-base"
PushTriggerPRUpdateWithBase PushTrigger = "pr-update-with-base"
)
2019-12-28 00:15:04 +03:00
// InternalPushingEnvironment returns an os environment to switch off hooks on push
// It is recommended to avoid using this unless you are pushing within a transaction
// or if you absolutely are sure that post-receive and pre-receive will do nothing
// We provide the full pushing-environment for other hook providers
2021-12-10 04:27:50 +03:00
func InternalPushingEnvironment ( doer * user_model . User , repo * repo_model . Repository ) [ ] string {
2019-12-28 00:15:04 +03:00
return append ( PushingEnvironment ( doer , repo ) ,
EnvIsInternal + "=true" ,
)
}
2019-05-11 18:29:17 +03:00
// PushingEnvironment returns an os environment to allow hooks to work on push
2021-12-10 04:27:50 +03:00
func PushingEnvironment ( doer * user_model . User , repo * repo_model . Repository ) [ ] string {
2019-07-26 00:50:20 +03:00
return FullPushingEnvironment ( doer , doer , repo , repo . Name , 0 )
2019-07-01 04:18:13 +03:00
}
// FullPushingEnvironment returns an os environment to allow hooks to work on push
2021-12-10 04:27:50 +03:00
func FullPushingEnvironment ( author , committer * user_model . User , repo * repo_model . Repository , repoName string , prID int64 ) [ ] string {
2019-05-11 18:29:17 +03:00
isWiki := "false"
2019-07-26 00:50:20 +03:00
if strings . HasSuffix ( repoName , ".wiki" ) {
2019-05-11 18:29:17 +03:00
isWiki = "true"
}
2019-07-01 04:18:13 +03:00
authorSig := author . NewGitSig ( )
committerSig := committer . NewGitSig ( )
2019-05-11 18:29:17 +03:00
2020-08-30 10:24:39 +03:00
environ := append ( os . Environ ( ) ,
2019-07-01 04:18:13 +03:00
"GIT_AUTHOR_NAME=" + authorSig . Name ,
"GIT_AUTHOR_EMAIL=" + authorSig . Email ,
"GIT_COMMITTER_NAME=" + committerSig . Name ,
"GIT_COMMITTER_EMAIL=" + committerSig . Email ,
2019-07-26 00:50:20 +03:00
EnvRepoName + "=" + repoName ,
2020-01-12 12:36:21 +03:00
EnvRepoUsername + "=" + repo . OwnerName ,
2019-05-11 18:29:17 +03:00
EnvRepoIsWiki + "=" + isWiki ,
2019-07-01 04:18:13 +03:00
EnvPusherName + "=" + committer . Name ,
EnvPusherID + "=" + fmt . Sprintf ( "%d" , committer . ID ) ,
2020-08-30 10:24:39 +03:00
EnvRepoID + "=" + fmt . Sprintf ( "%d" , repo . ID ) ,
EnvPRID + "=" + fmt . Sprintf ( "%d" , prID ) ,
2020-09-07 06:53:42 +03:00
EnvAppURL + "=" + setting . AppURL ,
2019-07-01 04:18:13 +03:00
"SSH_ORIGINAL_COMMAND=gitea-internal" ,
2019-05-11 18:29:17 +03:00
)
2020-08-30 10:24:39 +03:00
if ! committer . KeepEmailPrivate {
environ = append ( environ , EnvPusherEmail + "=" + committer . Email )
}
return environ
2019-05-11 18:29:17 +03:00
}