feat: Add structured output of products and their versions in bake.py

CHANGELOG.md

@@ -7,8 +7,10 @@ All notable changes to this project will be documented in this file.
 ## Added
 
 - Add `--target-containerfile` argument to override the default `Dockerfile` value ([#44]).
+- Add `--list-products` argument to get a machine-readable (JSON) output of all products and their versions ([#45]).
 
 [#44]: https://github.com/stackabletech/image-tools/pull/44
+[#45]: https://github.com/stackabletech/image-tools/pull/45
 
 ## 0.0.13 - 2024-09-06
 

src/image_tools/args.py

@@ -83,6 +83,12 @@ def bake_args() -> Namespace:
 
     parser.add_argument("--cache", help="Enable distributed build cache", action="store_true")
 
+    parser.add_argument(
+        "--list-products",
+        action="store_true",
+        help="Display structured output of products and their versions in JSON format",
+    )
+
     parser.add_argument(
         "--build-arg",
         help="Override build arguments. Expecting an KEY=VALUE format. The key is case insensitive.",

src/image_tools/bake.py

@@ -22,6 +22,15 @@
 from .version import version
 
 
+def print_product_versions_json(conf) -> None:
+    """Prints a JSON structured output of products and their versions."""
+    products_info = {}
+    for product in conf.products:
+        products_info[product["name"]] = [version["product"] for version in product.get("versions", [])]
+
+    print(json.dumps(products_info, indent=2))
+
+
 def build_image_args(conf_build_args: Dict[str, str], release_version: str):
     """
     Returns a list of --build-arg command line arguments that are used by the
@@ -214,6 +223,9 @@ def main() -> int:
         return 0
 
     conf = load_configuration(args.configuration, args.build_arg)
+    if args.show_products:
+        print_product_versions_json(conf)
+        return 0
 
     bakefile = generate_bakefile(args, conf)