From 317c654d22b55269fae3e543480993ff700b1cfa Mon Sep 17 00:00:00 2001 From: Damien Menanteau Date: Tue, 10 Sep 2024 09:25:45 +0200 Subject: [PATCH] [#674] Make mermaid-generated images available to webapp --- variants-doc/generate_png.bash | 10 ---------- variants-doc/mmd/generate_png.bash | 14 ++++++++++++++ variants-doc/{ => mmd}/variant-btcr.mmd | 0 variants-doc/{ => mmd}/variant-original.mmd | 0 variants-doc/{ => mmd}/variant-relaxed.mmd | 0 variants-doc/tcr_variants.md | 6 +++--- .../src/assets/images}/variant-btcr.png | Bin .../src/assets/images}/variant-original.png | Bin .../src/assets/images}/variant-relaxed.png | Bin 9 files changed, 17 insertions(+), 13 deletions(-) delete mode 100644 variants-doc/generate_png.bash create mode 100644 variants-doc/mmd/generate_png.bash rename variants-doc/{ => mmd}/variant-btcr.mmd (100%) rename variants-doc/{ => mmd}/variant-original.mmd (100%) rename variants-doc/{ => mmd}/variant-relaxed.mmd (100%) rename {variants-doc => webapp/src/assets/images}/variant-btcr.png (100%) rename {variants-doc => webapp/src/assets/images}/variant-original.png (100%) rename {variants-doc => webapp/src/assets/images}/variant-relaxed.png (100%) diff --git a/variants-doc/generate_png.bash b/variants-doc/generate_png.bash deleted file mode 100644 index 61ec0621..00000000 --- a/variants-doc/generate_png.bash +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -echo "Installing mermaid-cli" -npm update -g @mermaid-js/mermaid-cli || echo "Failed to install mermaid-cli. Aborting" - -for mmd_file in ./*.mmd; do - png_file="${mmd_file%.mmd}.png" - echo "- Generating ${png_file} from ${mmd_file}" - mmdc --input "${mmd_file}" --output "${png_file}" --theme dark --backgroundColor transparent -done diff --git a/variants-doc/mmd/generate_png.bash b/variants-doc/mmd/generate_png.bash new file mode 100644 index 00000000..3b9564e4 --- /dev/null +++ b/variants-doc/mmd/generate_png.bash @@ -0,0 +1,14 @@ +#!/usr/bin/env bash + +echo "Installing mermaid-cli" +npm update -g @mermaid-js/mermaid-cli || echo "Failed to install mermaid-cli. Aborting" + +repo_root_dir="$(git rev-parse --show-toplevel)" +webapp_images_dir="${repo_root_dir}/webapp/src/assets/images" + +echo "Generating files into ${webapp_images_dir}" +for mmd_file in ./*.mmd; do + png_file="${mmd_file%.mmd}.png" + echo "- Generating ${png_file} from ${mmd_file}" + mmdc --input "${mmd_file}" --output "${webapp_images_dir}/${png_file}" --theme dark --backgroundColor transparent +done diff --git a/variants-doc/variant-btcr.mmd b/variants-doc/mmd/variant-btcr.mmd similarity index 100% rename from variants-doc/variant-btcr.mmd rename to variants-doc/mmd/variant-btcr.mmd diff --git a/variants-doc/variant-original.mmd b/variants-doc/mmd/variant-original.mmd similarity index 100% rename from variants-doc/variant-original.mmd rename to variants-doc/mmd/variant-original.mmd diff --git a/variants-doc/variant-relaxed.mmd b/variants-doc/mmd/variant-relaxed.mmd similarity index 100% rename from variants-doc/variant-relaxed.mmd rename to variants-doc/mmd/variant-relaxed.mmd diff --git a/variants-doc/tcr_variants.md b/variants-doc/tcr_variants.md index 345f1908..7f6f6aec 100644 --- a/variants-doc/tcr_variants.md +++ b/variants-doc/tcr_variants.md @@ -24,7 +24,7 @@ The state diagrams below summarize the behavior of each variant. tcr --variant=original ``` -![TCR Original variant](./variant-original.png) +![TCR Original variant](../webapp/src/assets/images/variant-original.png) ## BTCR - Build && Test && Commit || Revert @@ -32,7 +32,7 @@ tcr --variant=original tcr --variant=btcr ``` -![TCR BTCR variant](./variant-btcr.png) +![TCR BTCR variant](../webapp/src/assets/images/variant-btcr.png) ## The Relaxed @@ -42,4 +42,4 @@ tcr --variant=relaxed The above option `--variant=relaxed` may be omitted as this is the default variant. -![TCR Relaxed variant](./variant-relaxed.png) +![TCR Relaxed variant](../webapp/src/assets/images/variant-relaxed.png) diff --git a/variants-doc/variant-btcr.png b/webapp/src/assets/images/variant-btcr.png similarity index 100% rename from variants-doc/variant-btcr.png rename to webapp/src/assets/images/variant-btcr.png diff --git a/variants-doc/variant-original.png b/webapp/src/assets/images/variant-original.png similarity index 100% rename from variants-doc/variant-original.png rename to webapp/src/assets/images/variant-original.png diff --git a/variants-doc/variant-relaxed.png b/webapp/src/assets/images/variant-relaxed.png similarity index 100% rename from variants-doc/variant-relaxed.png rename to webapp/src/assets/images/variant-relaxed.png