1
1
mirror of https://github.com/go-gitea/gitea synced 2024-12-24 17:44:27 +00:00
gitea/docs/content/doc/actions/overview.en-us.md
Jason Song 8f314c6793
Docs for Gitea Actions (#24405)
A new documentation section for Gitea Actions.

Some content comes from:

- [Hacking on Gitea
Actions](https://blog.gitea.io/2023/03/hacking-on-gitea-actions/)
- The README of [act_runner](https://gitea.com/gitea/act_runner)
- @ChristopherHX's excellent overview of the differences between Gitea
Actions and GitHub Actions in [this
comment](https://github.com/go-gitea/gitea/issues/13539#issuecomment-1448888850).

---------

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2023-05-05 20:07:20 +00:00

2.2 KiB

date title slug weight draft toc menu
2023-04-27T15:00:00+08:00 Gitea Actions usage/actions/overview 1 false false
sidebar
parent name weight identifier
actions Overview 1 actions-overview

Gitea Actions

Starting with Gitea 1.19, Gitea Actions are available as a built-in CI/CD solution.

Table of Contents

{{< toc >}}

Name

It is similar and compatible to GitHub Actions, and its name is inspired by it too. To avoid confusion, we have clarified the spelling here:

  • "Gitea Actions" (with an "s", both words capitalized) is the name of the Gitea feature.
  • "GitHub Actions" is the name of the GitHub feature.
  • "Actions" could refer to either of the above, depending on the context. So it refers to "Gitea Actions" in this document.
  • "action" or "actions" refer to some scripts/plugins to be used, like "actions/checkout@v3" or "actions/cache@v3".

Runners

Just like other CI/CD solutions, Gitea doesn't run the jobs itself, but delegates the jobs to runners. The runner of Gitea Actions is called act runner, it is a standalone program and also written in Go. It is based on a fork of nektos/act.

Because the runner is deployed independently, there could be potential security issues. To avoid them, please follow two simple rules:

  • Don't use a runner you don't trust for your repository, organization or instance.
  • Don't provide a runner to a repository, organization or instance you don't trust.

For Gitea instances used internally, such as instances used by enterprises or individuals, neither of these two rules is a problem, they are naturally so. However, for public Gitea instances, such as gitea.com, these two rules should be kept in mind when adding or using runners.

Status

Gitea Actions is still under development, so there may be some bugs and missing features. And breaking changes may be made before it's stable (v1.20 or later).

If the situation changes, we will update it here. So please refer to the content here when you find outdated articles elsewhere.