From 0bfc8a15a8d46d680bc0d4896f2dc255d4f1822d Mon Sep 17 00:00:00 2001 From: Austin Bozowski Date: Thu, 14 Apr 2022 16:24:08 -0700 Subject: [PATCH] Adding a readme just so this branch is clear --- .../docker/images/chip-build-zap/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 integrations/docker/images/chip-build-zap/README.md diff --git a/integrations/docker/images/chip-build-zap/README.md b/integrations/docker/images/chip-build-zap/README.md new file mode 100644 index 00000000000000..ffcbb69dc5908b --- /dev/null +++ b/integrations/docker/images/chip-build-zap/README.md @@ -0,0 +1,14 @@ +# ZAP + +- This image builds `zap` which gets copied into `chip-build-vscode`. +- `build.sh` has been modified with a special condition to populate `chip-build-zap`'s build context with the hashes of the CHIP repo working tree and target `zap` version in `zapinfo`. +- `zapinfo` gets copied to the images at `/opt/zap/zapinfo` and has the following format: +``` +CUSTOM YES|NO "project-chip/connectedhomeip" $chip_sha "project-chip/zap" $zap_sha +``` +- `CUSTOM YES` denotes that the `--zap=COMMIT_HASH` argument was issued to `build.sh`. `zap` will be installed at the provided hash. +- `CUSTOM NO` denotes the default path. In this case, the hash of `zap` is obtained from the `zap` submodule in the working tree. +- In either situation, `zap` is cloned into the image at build time (instead of copying from local sources which may have changes). + - Problem: The build does not account for local updates to the submodule in the current working tree. + - Solution: Also clone CHIP repo at build time and check against current hash from working tree. +