Testing-farm forge action

Warning

This forge action is only provided until proper packit support becomes available.

This action allows to trigger a testing-farm job from forgejo action on forge.fedoraproject.org only.

Note

Due to the design of forgejo/github actions, this action will consume a whole runner until the testing-farm job is complete. Make sure you provide an appropriate timeout-minutes for the job.

Usage

By default the action will request a testing-farm job for the current repository and the current git ref that it is being run under. The only required key is api_key corresponding to the testing-farm api token.

jobs:
  testing-farm-job:
    runs-on: testing-farm
    steps:
#     both short and long name formats are supported, i.e. either of:
#      - uses: https://forge.fedoraproject.org/ci/testing-farm@main
      - uses: ci/testing-farm@main
        with:
          api_key: ${{ secrets.TESTING_FARM_API_TOKEN }}

Note

Please use the testing-farm runner here which can run many more jobs concurrently. File a Request CI Runner ticket and specify testing-farm under "Resource Requirements" to get access to such a runner.

Note

Due to how forgejo limits the access of secrets, you cannot run this with on: pull_request if the source is a fork. Use on: pull_request_target to allow this kind of workflow to be run from forked repos, e.g.

on:
  push:
    branches:
      - main
  pull_request_target:

Available options

Here is a breakdown of the available inputs that can be specified for this action. For more details see the action.yaml file.

Input	Default	Description
api_key	(REQUIRED)	testing-farm api token
path	.	Path to tmt root
git_url	(current repo)	Git url to the tmt tests
git_ref	(current ref)	Git ref to clone
plan	.*	Regex pattern of plans to be run
arch	x86_64	Architecture to request
compose	(null)	Compose to provision. If not provided provision/container is forced.
skip_guest_setup	true	Skip testing-farm's guest setup (not used outside package testing)