summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Raghavan <arun@arunraghavan.net>2019-11-19 07:35:10 +0530
committerWim Taymans <wim.taymans@gmail.com>2019-11-19 14:45:53 +0000
commit5abab5d4daba88c45b0f642fde3a9f332d22881a (patch)
tree7fd0b08e924904ed8259658f90099bcfb287a594
parentef94b5c345a0791bb16e5c7f25a4a8baa5a97e23 (diff)
doc: Add some documentation on generating CI docker images
-rw-r--r--doc/ci.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/ci.md b/doc/ci.md
new file mode 100644
index 00000000..06e154ae
--- /dev/null
+++ b/doc/ci.md
@@ -0,0 +1,30 @@
+# Continuous Integration
+
+Our CI runs on the `gitlab.freedesktop.org` infrastructure. Steps can be found
+in the top-level `gitlab-ci.yml` file.
+
+The current build happens on an x86_64, Fedora 31 image. This should be
+extended to other distrubtions and architectures over time.
+
+## fd.o Registry
+
+The Docker image used for the build process comes from the
+`registry.freedesktop.org` container registry. Images are currently manually
+generate and pushed using the top-level `Dockerfile` and the following steps.
+The assumption is that you are using `podman` as a `docker` alternative. The
+corresponding `docker` command should be easy to find.
+
+```sh
+$ cd <pipewire-top-level-direcory>
+
+# Build the image
+$ podman build --format=docker -t registry.freedesktop.org/pipewire/pipewire/fedora:31 .
+
+# This is usually only needed once. You will be prompted for your fd.o
+# username, and the password is a personal access token that you must generate
+# in the gitlab.fd.o user settings.
+$ podman login
+
+# Upload the image
+$ podman push registry.freedesktop.org/pipewire/pipewire/fedora:31
+```