DISCLAIMER: This repository is an area of very active development. Outdated documentation and breaking changes might occur.
The SPDK CI repository contains workflows and actions responsible for
test execution. The actual test scripts (e.g., autotest.sh) and test
environment preparation scripts (e.g., autotest_setup.sh, pkgdep.sh)
are maintained in the SPDK repository.
The goal is to create a unified test execution framework for CI systems across multiple locations, companies, and hardware, ensuring that a minimal set of tests can be executed without relying on resources outside of GitHub.
Gerrit offers an API that allows reactions to a multitude of events. This is extremely useful for interacting with specific changes, reacting to comments, and merges.
The Gerrit webhooks plugin
is now used to forward a subset of Gerrit events to gerrit-webhook-handler.yml.
This workflow serves as the starting point for further test executions.
A subset of SPDK tests is intended to be executed only on GitHub-hosted runners.
The workflow spdk-common-tests.yml is the starting point for these tests.
These runners have limited resources and, for the purpose of SPDK tests,
can only suffice as VMs.
Workflows to be executed on SPDK Community self-hosted runners should be attached to the webhook handler. These runners might have different resources and environments; as such, they should be provisioned and attached as self-hosted runners, outside of any workflow in this repository.
The self-hosted runners can reuse the same setup as common SPDK tests. Attaching new self-hosted runners to the GitHub repository is a privileged operation, so please reach out on #spdk-ci if you are interested in participating.
Some operations are common enough to be abstracted out and reused across workflows.
A set of actions to interact with Gerrit, allowlist GitHub organization members,
or manage artifacts of the SPDK CI repository, shall be placed in .github/actions/*.