From 52234c5fd18077c6b8b99af312a090c175ae7f11 Mon Sep 17 00:00:00 2001
From: Achilleas Koutsou <achilleas@koutsou.net>
Date: Wed, 19 Jul 2023 11:42:49 +0200
Subject: [PATCH] test/README: describe vendoring of modified images repo

Add instructions for how to test an updated osbuild/images repo against
osbuild-composer.
---
 test/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/test/README.md b/test/README.md
index 3bed05bc0..e4a2cd52a 100644
--- a/test/README.md
+++ b/test/README.md
@@ -60,6 +60,24 @@ tests, see `.github/workflows/tests.yml`.
 
 ## Image tests
 
+The distributions and images are defined in a separate repository at
+https://github.com/osbuild/images. When making changes in that repository, you
+may want to test them against osbuild-composer. You can update the vendored
+code for osbuild/images as follows:
+```
+go mod edit -replace github.com/osbuild/images=<path to your local checkout of osbuild/images>
+./tools/prepare-source.sh
+```
+
+Alternatively, you can also use a remote fork/branch of the code:
+```
+go mod edit -replace github.com/osbuild/images=github.com/<username>/images@<commit>
+./tools/prepare-source.sh
+```
+
+This will allow you to open a test PR and run the osbuild-composer integration
+tests against your updated code.
+
 In the `test/data/manifests` directory, sample image builds and their tests are
 collected for the various distros, architectures, configuration we support.