Implement actions

[wolfogre]

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?
  • Implement actions #21937 (comment)
• Why the api for runners is not under the normal /api/v1 prefix?
  • Implement actions #21937 (comment)
• Why DBFS?
  • Implement actions #21937 (comment)
• Why ignore events triggered by gitea-actions bot?
  • Implement actions #21937 (comment)
• Why there's no permission control for actions?
  • Implement actions #21937 (comment)

What it looks like

Manage runners

List runs

View logs

How to try it

1. Start Gitea

Clone this branch and install from source.

Add additional configurations in app.ini to enable Actions:

[actions]
ENABLED = true

Start it.

If all is well, you'll see the management page of runners:

2. Start runner

Clone the act_runner, and follow the README to start it.

If all is well, you'll see a new runner has been added:

3. Enable actions for a repo

Create a new repo or open an existing one, check the Actions checkbox in settings and submit.

If all is well, you'll see a new tab "Actions":

4. Upload workflow files

Upload some workflow files to .gitea/workflows/xxx.yaml, you can follow the quickstart of GitHub Actions. Yes, Gitea Actions is compatible with GitHub Actions in most cases, you can use the same demo:

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:

5. Check the logs of jobs

Click a run and you'll see the logs:

6. Go on

You can try more examples in the documents of GitHub Actions, then you might find a lot of bugs.

Come on, PRs are welcome.

See also: Feature Preview: Gitea Actions

[Gusted]

I don't intend to review other parts of the code, but this was too notable.

---

Is it also intended to create documentation for this?

[KN4CK3R]

Is "bots" the name of the whole CI/CD feature? If yes, then I think that's not a good name because bots are usually something different (machine controlled user accounts).

[lunny]

It's not only CICD, that's why we don't name it Gitea CI. We have a name discuss in #13539, maybe automate is a better name.

[delvh]

So, after a lot of problems, I've finally been able to successfully test the most critical parts.

I still made some observations:

as you can see here, , the branch still has the BranchPrefix.
Additionally, only about 5% of the time when I click on the Rerun action, it will actually be rerun. And I can see at the same time that the runner does not get any new tasks while polling.
The last problem I noticed is that canceled workflows are displayed with the same color as failed workflows, but there is no indication anywhere that the reason for this is that the task was canceled.
Lastly, as you might know already, I absolutely dislike the DBFS.
I also noticed some minor things which you can see in the history of all comments on this PR.

However, as it seems at the moment, these things will all be postponed for later PRs.
Once this PR is merged, I'll create a follow-up issue where I post everything that was postponed here to merge it in time for 1.19.

[wxiaoguang]

Lastly, as you might know already, I absolutely dislike the DBFS.

I would like to suggest reviewers to always provide alternative and feasible solutions when something is disliked. Otherwise, there will be non-sense arguments, the author won't know what to do.

[ChristopherHX]

the branch still has the BranchPrefix

This is expected behavior. Use github.ref_name if you don't want the prefix.

EDIT
I see github.ref_name is incorrect in this PR, github.ref should not be equal to github.ref_name.
I expected that github.ref_name is correct, because it has no refs/heads/ prefix under nektos/act.

[yardenshoham]

PR's too awesome for lgtm bot to handle? Both @lunny + @delvh approved!

[delvh]

I've done the work of the 🤖 now myself.
Let's let it 😴 a bit longer. It needs the rest.

[delvh]

Okay, now I feel bullied.

[lunny]

@delvh You did work well. Thank you very much!!!

[lunny]

make LG-TM work

[wULLSnpAXbWZGYDYyhWTKKspEQoaYxXyhoisqHf]

great work y'all!
can I ask, does "It shouldn't be used in a public Gitea instance currently;" still apply or was it there just for the development phase?

[delvh]

That sentence is meanst as "large public instances such as Codeberg should probably not enable it", mainly because of the stress it places on that system.
For instances where you know everyone, this shouldn't apply.

[ghnp5]

Hey!

My understanding is that this is merged to main.

I have updated the Docker image earlier today, from the latest release.

I have:

[actions]
ENABLED = true

But Gitea 1.18.4 (shows on the footer) still doesn't show anything about Actions/Runners.

Am I doing anything wrong, or does this release not yet include Actions at all?

Thanks!

[lunny]

If you are using docker, using dev currently not 1.18.4.