erabo/spiegel_podman
1
0
Fork 0
mirror of https://github.com/podman-container-tools/podman.git synced 2026-09-10 01:27:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
spiegel_podman/contrib/cirrus/CIModes.md
Chris Evich 95eb22c71c
Support a machine-test only mode 
Because the podman machine tests normally run at the end of the chain,
it's time consuming for developers to validate machine-only changes.
Support a special CI runtime mode, only when a PR is marked as a draft.
Update related documentation

Also: Only run machine tests on PRs, never for branches or new tags.

Signed-off-by: Chris Evich <cevich@redhat.com>
2023-12-11 11:02:32 -05:00

4.4 KiB
Raw Blame History

The following is a list (incomplete) of the primary contexts and runtime "modes" supported by podman CI. Note that there may be additional checks done regarding "skipping work" in the runner.sh script. This document only details the controls at the .cirrus.yml level.

Visualization

The relationship between tasks can be incredibly hard to understand by staring at the YAML. A tool exists for producing a graph (flow-chart) of the .cirrus.yml file. A (possibly outdated) example of it's output can be seen below:

cirrus-task-map output

Implementation notes

  • The skip conditional should never be used for tasks. While it's arguably easier to read that only_if, it leads to a cluttered status output that's harder to page through when reviewing PRs. As opposed to only_if which will bypass creation of the task (at runtime) completely. Also, by sticking to one conditional style, it's easier to re-use the YAML statements across multiple tasks.

  • The only variables which can be used as part of conditions are defined by Cirrus-CI. The list is documented. Reference to any variables defined in YAML will not behave how you expect, don't use them!

  • Some Cirrus-CI defined variables contain non-empty values outside their obvious context. For example, when running for a PR a task will have $CIRRUS_BRANCH set to pull/<number>.

  • Conditions which use positive or negative regular-expressions have several "flags" set: "Multi-line" and "Case-insensitive".

Testing

Executing most of the modes can be mocked by forcing values for (otherwise) Cirrus-CI defined variables. For example $CIRRUS_TAG. As of the publishing of this document, it's not possible to override the behavior of $CIRRUS_PR.

Cirrus Task contexts and runtime modes

Intended general PR Tasks (italic: matrix)

  • build
  • validate
  • bindings
  • swagger
  • alt_build
  • osx_alt_build
  • freebsd_alt_build
  • docker-py_test
  • unit_test
  • apiv2_test
  • compose_test
  • local_integration_test
  • remote_integration_test
  • container_integration_test
  • rootless_integration_test
  • local_system_test
  • remote_system_test
  • rootless_remote_system_test
  • buildah_bud_test
  • rootless_system_test
  • rootless_gitlab_test
  • upgrade_test
  • meta
  • success
  • artifacts

Intended for PR w/ "release" or "bump" in title:

  • (All the general PR tasks above)
  • release_test

Intended [CI:DOCS] PR Tasks:

  • build
  • validate
  • swagger
  • meta
  • success

Intended [CI:BUILD] PR Tasks:

  • build
  • validate
  • alt_build
  • osx_alt_build
  • freebsd_alt_build
  • meta
  • success
  • artifacts

Intended [CI:MACHINE] PR Tasks:

If and only if the PR is in draft-mode, run only the following tasks. The draft-mode check is necessary to remove the risk of merging a change that affects the untested aspects of podman.

  • build
  • validate
  • alt_build
  • win_installer
  • osx_alt_build
  • podman_machine_task
  • podman_machine_aarch64_task
  • podman_machine_windows_task
  • podman_machine_mac_task
  • meta
  • success
  • artifacts

Intended [CI:NEXT] behavior:

If and only if the PR is in draft-mode, update Fedora CI VMs at runtime to the latest packages available in the podman-next COPR repo. These packages represent primary podman dependencies, and are regularly built from their upstream repos. These are runtime changes only, and will not persist or impact other PRs in any way.

The intent is to temporarily support testing of updates with the latest podman code & tests. To help prevent accidents, when the PR is not in draft-mode, the presence of the magic string will cause VM-setup script to fail, until the magic is removed.

Note: When changing the draft-status of PR, you will need to re-push a commit-change before Cirrus-CI will notice the draft-status update (i.e. pressing the re-run button is not good enough).

Intended Branch tasks (and Cirrus-cron jobs):

  • build
  • swagger
  • alt_build
  • osx_alt_build
  • freebsd_alt_build
  • local_system_test
  • remote_system_test
  • rootless_remote_system_test
  • rootless_system_test
  • meta
  • success
  • artifacts

Intended for new Tag tasks:

  • build
  • swagger
  • alt_build
  • osx_alt_build
  • freebsd_alt_build
  • meta
  • success
  • artifacts
  • release