Merge pull request #317 from gardenlinux/fix/s3-metadata-key-used-without-check

Allow S3 metadata key `published_image_metadata` to be undefined

Author: saubhikdattagithub

.github/actions/setup/action.yml

@@ -4,7 +4,7 @@ description: Installs the given GardenLinux Python library
 inputs:
   version:
     description: GardenLinux Python library version
-    default: "0.10.14"
+    default: "0.10.15"
   python_version:
     description: Python version to setup
     default: "3.13"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gardenlinux"
-version = "0.10.14"
+version = "0.10.15"
 description = "Contains tools to work with the features directory of gardenlinux, for example deducting dependencies from feature sets or validating cnames"
 authors = ["Garden Linux Maintainers <contact@gardenlinux.io>"]
 license = "Apache-2.0"

src/gardenlinux/github/release_notes/deployment_platform/__init__.py

@@ -15,7 +15,7 @@ def full_name(self) -> str:
     def published_images_by_regions(
         self, image_metadata: Dict[str, Any]
     ) -> Dict[str, Any]:
-        published_image_metadata = image_metadata["published_image_metadata"]
+        published_image_metadata = image_metadata.get("published_image_metadata", {})
         flavor_name = image_metadata["s3_key"].split("/")[-1]
 
         regions = []

src/gardenlinux/github/release_notes/deployment_platform/amazon_web_services.py

@@ -13,7 +13,7 @@ def full_name(self) -> str:
     def published_images_by_regions(
         self, image_metadata: Dict[str, Any]
     ) -> Dict[str, Any]:
-        published_image_metadata = image_metadata["published_image_metadata"]
+        published_image_metadata = image_metadata.get("published_image_metadata", {})
         flavor_name = image_metadata["s3_key"].split("/")[-1]
 
         regions = []

src/gardenlinux/github/release_notes/deployment_platform/azure.py

@@ -16,7 +16,7 @@ def image_extension(self) -> str:
     def published_images_by_regions(
         self, image_metadata: Dict[str, Any]
     ) -> Dict[str, Any]:
-        published_image_metadata = image_metadata["published_image_metadata"]
+        published_image_metadata = image_metadata.get("published_image_metadata", {})
         flavor_name = image_metadata["s3_key"].split("/")[-1]
 
         gallery_images = []

src/gardenlinux/github/release_notes/deployment_platform/google_cloud.py

@@ -17,7 +17,7 @@ def image_extension(self) -> str:
     def published_images_by_regions(
         self, image_metadata: Dict[str, Any]
     ) -> Dict[str, Any]:
-        published_image_metadata = image_metadata["published_image_metadata"]
+        published_image_metadata = image_metadata.get("published_image_metadata", {})
         flavor_name = image_metadata["s3_key"].split("/")[-1]
 
         details = {}

src/gardenlinux/github/release_notes/deployment_platform/openstack.py

@@ -14,7 +14,7 @@ def full_name(self) -> str:
     def published_images_by_regions(
         self, image_metadata: Dict[str, Any]
     ) -> Dict[str, Any]:
-        published_image_metadata = image_metadata["published_image_metadata"]
+        published_image_metadata = image_metadata.get("published_image_metadata", {})
         flavor_name = image_metadata["s3_key"].split("/")[-1]
 
         regions = []

src/gardenlinux/github/release_notes/sections.py

@@ -1,6 +1,7 @@
 import logging
 import re
 import textwrap
+from collections.abc import Mapping
 from typing import Any, Dict
 
 import requests
@@ -262,9 +263,13 @@ def release_notes_image_ids_section(metadata_files: list[str]) -> str:
         with open(metadata_file_path) as f:
             metadata = yaml.load(f, Loader=SafeLoader)
 
-        published_image_metadata = metadata["published_image_metadata"]
+        published_image_metadata = metadata.get("published_image_metadata", {})
+
         # Skip if no publishing metadata found
-        if published_image_metadata is None:
+        if (
+            not isinstance(published_image_metadata, Mapping)
+            or len(published_image_metadata) < 1
+        ):
             continue
 
         platform = metadata["platform"]