From 3464e437c294ae59da19e22321d66534ff5c5b30 Mon Sep 17 00:00:00 2001 From: Michael Valdron Date: Wed, 26 Jul 2023 11:58:01 -0400 Subject: [PATCH] add README instruction on dependency check changes Signed-off-by: Michael Valdron --- tests/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/tests/README.md b/tests/README.md index 424249f8..1ac93c4c 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,5 +1,29 @@ # Devfile Registry Testing +## Dependency check + +### Prerequisites + +- Ensure `yq 4.3x` is installed + +### Running the build script + +- This script performs three actions + - Clones samples from provided `extraDevfileEntries.yaml` under `samples/.cache` + - Creates a `parents.yaml` which contains the dependency tree for parent stacks + - Outputs the child sample paths of parent stacks, `TEST_DELTA=true` will result in only outputting child samples which have changed parent stacks +- The build script takes one optional argument and works off of the current working directory + - `bash tests/build_parents_file.sh`, default samples file is `extraDevfileEntries.yaml` + - `bash tests/build_parents_file.sh ` + +### Use with testing + +- One can test the child samples using the [validate_devfile_schemas]() test suite by performing the following: +```sh +export STACKS=$(bash tests/build_parents_file.sh) +STACKS_DIR=samples/.cache bash tests/validate_devfile_schemas.sh +``` + ## Validating non-terminating images ### Prerequisites