Forgejo Actions

Forgejo Actions is developed by the Forgejo team. It allows GitHub-actions based workflows and is directly integrated into Forgejo, the software powering CodeFloe.

Available Runners

To run an action, you need to delegate it to an available runner. All runner have labels set which can be referenced in the runs-on field. All available labels are listed at https://codefloe.com/user/settings/actions/runners (Login required). Some labels reference multiple runners while others reference a single runner. The names aim to describe the underlying environment in a descriptive manner.

Tip

For container/docker actions, use the docker label. This will create an environment where you can talk to a Docker daemon running via dind.

Example Workflow

An example workflow could look like this:

name: hello-world

on:
  push:
  workflow_dispatch:

jobs:
  hello-world:
    runs-on: debian-latest
    defaults:
      run:
        shell: sh
    steps:
      - name: hello-world
        run: |
          echo "Hello, World!"
          sleep 30

Platform Support

Caution

The common windows-latest and macos-latest labels from GitHub Actions are not supported. This is because Forgejo runner does not officially support these platforms (and both do not support container-based actions natively).

Note

As all Actions are by default written in JavaScript, the base image that all jobs run within must support NodeJS. You can use an arbitrary image without node if you are not planning to use any predefined actions.

Custom Containers

All jobs run within containers. The runs-on: key specifies a compatible NodeJS image (either LTS or latest) which is able to execute Actions. You can also use the containers: key to specify an arbitrary container image for a job of yours. Note that when doing so, Actions are not supported if this image does not have NodeJS installed.

name: hello-world

on:
  push:
  workflow_dispatch:

jobs:
  hello-world:
    runs-on: debian-latest
    container:
      image: library/alpine:latest
    defaults:
      run:
        shell: sh
    steps:
      - name: hello-world
        run: |
          echo "Hello, World!"
          sleep 30

Log and Artifact Retention

Job logs are preserved for 365 days. Artifacts are preserved for 30 days by default. Individual artifact uploads can request a different retention period with the retention-days option of actions/upload-artifact.

Forgejo checks for expired Actions logs and artifacts every day at 00:35 UTC and removes them after their retention period has elapsed. The workflow run entry can remain visible after its associated logs or artifacts have expired.

Support

If you encounter usage issues and/or have feature requests regarding Actions itself, please report them directly in the respective Forgejo repository. If you instead face any issues using Actions on CodeFloe, you are welcome to open a thread in our Forum.