spaceforge 0.0.3__tar.gz → 0.0.5__tar.gz

{spaceforge-0.0.3 → spaceforge-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 0.0.3
+Version: 0.0.5
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift
@@ -28,6 +28,7 @@ License-File: LICENSE
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: click>=8.0.0
 Requires-Dist: pydantic>=2.11.7
+Requires-Dist: Jinja2>=3.1.0
 Provides-Extra: dev
 Requires-Dist: pytest>=6.0; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -584,6 +585,15 @@ export SPACEFORGE_PARAM_SEVERITY_THRESHOLD="high"
 spaceforge runner after_plan
 ```
 
+## Speeding up plugin execution
+
+There are a few things you can do to speed up plugin execution.
+
+1. Ensure your runner has `spaceforge` preinstalled. This will avoid the overhead of installing it during the run. (15-30 seconds)
+2. If youre using binaries, we will only install the binary if its not found. You can gain a few seconds by ensuring its already on the runner.
+3. If your plugin has a lot of dependencies, consider using a prebuilt runner image with your plugin and its dependencies installed. This avoids the overhead of installing them during each run.
+4. Ensure your runner has enough core resources (CPU, memory) to handle the plugin execution efficiently. If your plugin is resource-intensive, consider using a more powerful runner.
+
 ## Next Steps
 
 1. **Install spaceforge:** `pip install spaceforge`

{spaceforge-0.0.3 → spaceforge-0.0.5}/README.md

@@ -540,6 +540,15 @@ export SPACEFORGE_PARAM_SEVERITY_THRESHOLD="high"
 spaceforge runner after_plan
 ```
 
+## Speeding up plugin execution
+
+There are a few things you can do to speed up plugin execution.
+
+1. Ensure your runner has `spaceforge` preinstalled. This will avoid the overhead of installing it during the run. (15-30 seconds)
+2. If youre using binaries, we will only install the binary if its not found. You can gain a few seconds by ensuring its already on the runner.
+3. If your plugin has a lot of dependencies, consider using a prebuilt runner image with your plugin and its dependencies installed. This avoids the overhead of installing them during each run.
+4. Ensure your runner has enough core resources (CPU, memory) to handle the plugin execution efficiently. If your plugin is resource-intensive, consider using a more powerful runner.
+
 ## Next Steps
 
 1. **Install spaceforge:** `pip install spaceforge`

{spaceforge-0.0.3 → spaceforge-0.0.5}/plugins/sops/plugin.yaml

@@ -131,10 +131,59 @@ contexts:
                   except Exception as e:
                       self.logger.error(f"An unexpected error occurred: {e}")
     sensitive: false
+  - path: /mnt/workspace/plugins/sops/binary_install_sops.sh
+    content: |-
+      #!/bin/sh
+
+      set -e
+
+      if command -v sops; then
+          echo "sops is already installed."
+          return
+      fi
+
+      mkdir -p /mnt/workspace/plugins/plugin_binaries
+
+      echo "Installing sops..."
+      mkdir -p /mnt/workspace/plugins/plugin_binaries
+      cd /mnt/workspace/plugins/plugin_binaries
+
+      if [ "$(arch)" = "x86_64" ]; then
+          curl https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.linux.amd64 -o /mnt/workspace/plugins/plugin_binaries/sops -L
+      else
+          curl https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.linux.arm64 -o /mnt/workspace/plugins/plugin_binaries/sops -L
+      fi
+
+      chmod +x /mnt/workspace/plugins/plugin_binaries/sops
+      cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
+    sensitive: false
+  - path: /mnt/workspace/plugins/sops/before_init.sh
+    content: |-
+      #!/bin/sh
+
+      set -e
+
+      cd /mnt/workspace/plugins/sops
+
+      if [ ! -d "./venv" ]; then
+          python -m venv ./venv
+      fi
+      . venv/bin/activate
+
+      if ! command -v spaceforge; then
+          pip install spaceforge
+      fi
+
+      if [ -f requirements.txt ] && [ ! -f .spaceforge_installed_requirements ]; then
+          pip install -r requirements.txt
+          touch .spaceforge_installed_requirements
+      fi
+
+      cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
+      spaceforge runner --plugin-file /mnt/workspace/plugins/sops/plugin.py before_init
+    sensitive: false
   hooks:
     before_init:
     - mkdir -p /mnt/workspace/plugins/sops
-    - cd /mnt/workspace/plugins/sops && python -m venv ./venv && source venv/bin/activate && pip install spaceforge
-    - pip install -r requirements.txt
-    - mkdir -p /mnt/workspace/plugins/plugin_binaries && cd /mnt/workspace/plugins/plugin_binaries && ([[ "$(echo "$(arch)")" == "x86_64" ]] && curl https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.linux.amd64 -o /mnt/workspace/plugins/plugin_binaries/sops -L && chmod +x /mnt/workspace/plugins/plugin_binaries/sops || curl https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.linux.arm64 -o /mnt/workspace/plugins/plugin_binaries/sops -L && chmod +x /mnt/workspace/plugins/plugin_binaries/sops) && cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
-    - cd /mnt/workspace/source/$TF_VAR_spacelift_project_root && python -m spaceforge runner --plugin-file /mnt/workspace/plugins/sops/plugin.py before_init
+    - chmod +x /mnt/workspace/plugins/sops/binary_install_sops.sh && /mnt/workspace/plugins/sops/binary_install_sops.sh
+    - chmod +x /mnt/workspace/plugins/sops/before_init.sh && /mnt/workspace/plugins/sops/before_init.sh

{spaceforge-0.0.3 → spaceforge-0.0.5}/plugins/wiz/plugin.py

@@ -88,9 +88,9 @@ webhook[{"endpoint_id": "wiz-alert-endpoint"}] {
   input.run_updated.run.marked_unsafe == true
 }
             """,
-            labels={
-                "policy_type": "security"
-            }
+            labels=[
+                "wiz-plugin"
+            ]
         )
     ]
 
@@ -179,4 +179,6 @@ webhook[{"endpoint_id": "wiz-alert-endpoint"}] {
                     markdown += "\n"
             if "reportUrl" in stdout_json:
                 markdown += f"<a href=\"{stdout_json['reportUrl']}\" rel=\"noopener noreferrer\">View Report</a>\n"
-            self.send_markdown(markdown)
+            result = self.send_markdown(markdown)
+            if not result:
+                self.logger.error("Failed to send Wiz CLI output to spacelift")

{spaceforge-0.0.3 → spaceforge-0.0.5}/plugins/wiz/plugin.yaml

@@ -134,9 +134,9 @@ contexts:
         input.run_updated.run.marked_unsafe == true
       }
                   """,
-                  labels={
-                      "policy_type": "security"
-                  }
+                  labels=[
+                      "wiz-plugin"
+                  ]
               )
           ]
 
@@ -225,15 +225,67 @@ contexts:
                           markdown += "\n"
                   if "reportUrl" in stdout_json:
                       markdown += f"<a href=\"{stdout_json['reportUrl']}\" rel=\"noopener noreferrer\">View Report</a>\n"
-                  self.send_markdown(markdown)
+                  result = self.send_markdown(markdown)
+                  if not result:
+                      self.logger.error("Failed to send Wiz CLI output to spacelift")
+    sensitive: false
+  - path: /mnt/workspace/plugins/wiz/binary_install_wizcli.sh
+    content: |-
+      #!/bin/sh
+
+      set -e
+
+      if command -v wizcli; then
+          echo "wizcli is already installed."
+          return
+      fi
+
+      mkdir -p /mnt/workspace/plugins/plugin_binaries
+
+      echo "Installing wizcli..."
+      mkdir -p /mnt/workspace/plugins/plugin_binaries
+      cd /mnt/workspace/plugins/plugin_binaries
+
+      if [ "$(arch)" = "x86_64" ]; then
+          curl https://downloads.wiz.io/wizcli/0.94.0/wizcli-linux-amd64 -o /mnt/workspace/plugins/plugin_binaries/wizcli -L
+      else
+          curl https://downloads.wiz.io/wizcli/0.94.0/wizcli-linux-arm64 -o /mnt/workspace/plugins/plugin_binaries/wizcli -L
+      fi
+
+      chmod +x /mnt/workspace/plugins/plugin_binaries/wizcli
+      cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
+    sensitive: false
+  - path: /mnt/workspace/plugins/wiz/before_plan.sh
+    content: |-
+      #!/bin/sh
+
+      set -e
+
+      cd /mnt/workspace/plugins/wiz
+
+      if [ ! -d "./venv" ]; then
+          python -m venv ./venv
+      fi
+      . venv/bin/activate
+
+      if ! command -v spaceforge; then
+          pip install spaceforge
+      fi
+
+      if [ -f requirements.txt ] && [ ! -f .spaceforge_installed_requirements ]; then
+          pip install -r requirements.txt
+          touch .spaceforge_installed_requirements
+      fi
+
+      cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
+      spaceforge runner --plugin-file /mnt/workspace/plugins/wiz/plugin.py before_plan
     sensitive: false
   hooks:
     before_init:
     - mkdir -p /mnt/workspace/plugins/wiz
-    - mkdir -p /mnt/workspace/plugins/plugin_binaries && cd /mnt/workspace/plugins/plugin_binaries && ([[ "$(echo "$(arch)")" == "x86_64" ]] && curl https://downloads.wiz.io/wizcli/0.94.0/wizcli-linux-amd64 -o /mnt/workspace/plugins/plugin_binaries/wizcli -L && chmod +x /mnt/workspace/plugins/plugin_binaries/wizcli || curl https://downloads.wiz.io/wizcli/0.94.0/wizcli-linux-arm64 -o /mnt/workspace/plugins/plugin_binaries/wizcli -L && chmod +x /mnt/workspace/plugins/plugin_binaries/wizcli) && cd /mnt/workspace/source/$TF_VAR_spacelift_project_root
+    - chmod +x /mnt/workspace/plugins/wiz/binary_install_wizcli.sh && /mnt/workspace/plugins/wiz/binary_install_wizcli.sh
     before_plan:
-    - cd /mnt/workspace/plugins/wiz && python -m venv ./venv && source venv/bin/activate && pip install spaceforge
-    - cd /mnt/workspace/source/$TF_VAR_spacelift_project_root && python -m spaceforge runner --plugin-file /mnt/workspace/plugins/wiz/plugin.py before_plan
+    - chmod +x /mnt/workspace/plugins/wiz/before_plan.sh && /mnt/workspace/plugins/wiz/before_plan.sh
 policies:
 - name_prefix: wiz_policy
   type: notification
@@ -245,4 +297,4 @@ policies:
       input.run_updated.run.marked_unsafe == true
     }
   labels:
-    policy_type: security
+  - wiz-plugin

{spaceforge-0.0.3 → spaceforge-0.0.5}/pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
     "PyYAML>=6.0",
     "click>=8.0.0", 
     "pydantic>=2.11.7",
+    "Jinja2>=3.1.0",
 ]
 
 [project.optional-dependencies]

{spaceforge-0.0.3 → spaceforge-0.0.5}/setup.py

@@ -43,6 +43,7 @@ setup(
         "PyYAML>=6.0",
         "click>=8.0.0",
         "pydantic>=2.11.7",
+        "Jinja2>=3.1.0",
     ],
     extras_require={
         "dev": [

{spaceforge-0.0.3 → spaceforge-0.0.5}/spaceforge/_version_scm.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.3'
-__version_tuple__ = version_tuple = (0, 0, 3)
+__version__ = version = '0.0.5'
+__version_tuple__ = version_tuple = (0, 0, 5)
 
-__commit_id__ = commit_id = 'ge171bdb88'
+__commit_id__ = commit_id = 'gd83c2c6ce'

{spaceforge-0.0.3 → spaceforge-0.0.5}/spaceforge/cls.py

@@ -118,7 +118,7 @@ class Context:
     Attributes:
         name_prefix (str): The name of the context, will be appended with a unique ID.
         description (str): A description of the context.
-        labels (dict): Labels associated with the context.
+        labels (Optional[List[str]]): Labels associated with the context.
         env (list): List of variables associated with the context.
         hooks (dict): Hooks associated with the context.
     """
@@ -128,7 +128,7 @@ class Context:
     env: Optional[List[Variable]] = optional_field
     mounted_files: Optional[List[MountedFile]] = optional_field
     hooks: Optional[Dict[HookType, List[str]]] = optional_field
-    labels: Optional[Dict[str, str]] = optional_field
+    labels: Optional[List[str]] = optional_field
 
 
 @pydantic_dataclass
@@ -139,14 +139,14 @@ class Webhook:
     Attributes:
         name_prefix (str): The name of the webhook, will be appended with a unique ID.
         endpoint (str): The URL endpoint for the webhook.
-        labels (Optional[dict]): Labels associated with the webhook.
-        secrets (Optional[list[Variable]]): List of secrets associated with the webhook.
+        labels (Optional[List[str]]): Labels associated with the webhook.
+        secret (str): the ID of the parameter where the webhook secret is retrieved from
     """
 
     name_prefix: str
     endpoint: str
-    labels: Optional[Dict[str, str]] = optional_field
-    secrets: Optional[List[Variable]] = optional_field
+    secretFromParameter: str
+    labels: Optional[List[str]] = optional_field
 
 
 @pydantic_dataclass
@@ -158,13 +158,13 @@ class Policy:
         name_prefix (str): The name of the policy, will be appended with a unique ID.
         type (str): The type of the policy (e.g., "terraform", "kubernetes").
         body (str): The body of the policy, typically a configuration or script.
-        labels (Optional[dict[str, str]]): Labels associated with the policy.
+        labels (Optional[List[str]]): Labels associated with the policy.
     """
 
     name_prefix: str
     type: str
     body: str
-    labels: Optional[Dict[str, str]] = optional_field
+    labels: Optional[List[str]] = optional_field
 
 
 @pydantic_dataclass

{spaceforge-0.0.3 → spaceforge-0.0.5}/spaceforge/generator.py

@@ -7,6 +7,7 @@ import os
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
 
 import yaml
+from jinja2 import Environment, PackageLoader, select_autoescape
 
 if TYPE_CHECKING:
     from .plugin import SpaceforgePlugin
@@ -47,6 +48,9 @@ class PluginGenerator:
         self.plugin_instance: Optional[SpaceforgePlugin] = None
         self.plugin_working_directory: Optional[str] = None
         self.config: Optional[Dict[str, Any]] = None
+        self.jinja = Environment(
+            loader=PackageLoader("spaceforge"), autoescape=select_autoescape()
+        )
 
     def load_plugin(self) -> None:
         """Load the plugin class from the specified path."""
@@ -84,7 +88,7 @@ class PluginGenerator:
         self.config = {
             "setup_virtual_env": (
                 f"cd {self.plugin_working_directory} && python -m venv ./venv && "
-                + "source venv/bin/activate && pip install spaceforge"
+                + "source venv/bin/activate && (command -v spaceforge &> /dev/null || pip install spaceforge)"
             ),
             "plugin_mounted_path": f"{self.plugin_working_directory}/{os.path.basename(self.plugin_path)}",
         }
@@ -137,14 +141,27 @@ class PluginGenerator:
 
         return hook_methods
 
-    def _update_with_requirements(
-        self, hooks: Dict[str, List[str]], mounted_files: List[MountedFile]
+    def _add_to_mounted_files(
+        self,
+        hooks: Dict[str, List[str]],
+        mounted_files: List[MountedFile],
+        phase: str,
+        filepath: str,
+        filecontent: str,
     ) -> None:
+        file = f"{self.plugin_working_directory}/{filepath}"
+        hooks[phase].append(f"chmod +x {file} && {file}")
+        mounted_files.append(
+            MountedFile(
+                path=f"{self.plugin_working_directory}/{filepath}",
+                content=filecontent,
+                sensitive=False,
+            )
+        )
+
+    def _update_with_requirements(self, mounted_files: List[MountedFile]) -> None:
         """Update the plugin hooks if there is a requirements.txt"""
         if os.path.exists("requirements.txt") and self.config is not None:
-            if self.config["setup_virtual_env"] not in hooks["before_init"]:
-                hooks["before_init"].append(self.config["setup_virtual_env"])
-            hooks["before_init"].append(f"pip install -r requirements.txt")
             # read the requirements.txt file
             with open("requirements.txt", "r") as f:
                 mounted_files.append(
@@ -167,7 +184,9 @@ class PluginGenerator:
                     )
                 )
 
-    def _add_spaceforge_hooks(self, hooks: Dict[str, List[str]]) -> None:
+    def _add_spaceforge_hooks(
+        self, hooks: Dict[str, List[str]], mounted_files: List[MountedFile]
+    ) -> None:
         # Add the spaceforge hook to actually run the plugin
         if self.config is None:
             raise ValueError("Plugin config not set. Call load_plugin() first.")
@@ -178,12 +197,14 @@ class PluginGenerator:
             if hook not in hooks:
                 hooks[hook] = []
 
-            if self.config["setup_virtual_env"] not in hooks[hook]:
-                hooks[hook].append(self.config["setup_virtual_env"])
-
-            hooks[hook].append(
-                f"cd /mnt/workspace/source/$TF_VAR_spacelift_project_root && python -m spaceforge runner --plugin-file {self.config['plugin_mounted_path']} {hook}"
+            directory = os.path.dirname(self.config["plugin_mounted_path"])
+            template = self.jinja.get_template("ensure_spaceforge_and_run.sh.j2")
+            render = template.render(
+                plugin_path=directory,
+                plugin_file=self.config["plugin_mounted_path"],
+                phase=hook,
             )
+            self._add_to_mounted_files(hooks, mounted_files, hook, f"{hook}.sh", render)
 
     def _map_variables_to_parameters(self, contexts: List[Context]) -> None:
         for context in contexts:
@@ -221,10 +242,10 @@ class PluginGenerator:
         }
         mounted_files: List[MountedFile] = []
 
-        self._update_with_requirements(hooks, mounted_files)
+        self._update_with_requirements(mounted_files)
         self._update_with_python_file(mounted_files)
-        self._generate_binary_install_command(hooks)
-        self._add_spaceforge_hooks(hooks)
+        self._generate_binary_install_command(hooks, mounted_files)
+        self._add_spaceforge_hooks(hooks, mounted_files)
 
         # Get the contexts and append the hooks and mounted files to it.
         if self.plugin_class is None:
@@ -256,46 +277,38 @@ class PluginGenerator:
 
         return contexts
 
-    def _generate_binary_install_command(self, hooks: Dict[str, List[str]]) -> None:
+    def _generate_binary_install_command(
+        self, hooks: Dict[str, List[str]], mounted_files: List[MountedFile]
+    ) -> None:
         binaries = self.get_plugin_binaries()
         if binaries is None:
             return None
 
-        binary_cmd = ""
-        if len(binaries) > 0:
-            binary_cmd = f"mkdir -p {static_binary_directory} && cd {static_binary_directory} && "
         for i, binary in enumerate(binaries):
             amd64_url = binary.download_urls.get("amd64", None)
             arm64_url = binary.download_urls.get("arm64", None)
+            binary_path = f"{static_binary_directory}/{binary.name}"
             if amd64_url is None and arm64_url is None:
                 raise ValueError(
                     f"Binary {binary.name} must have at least one download URL defined (amd64 or arm64)"
                 )
 
-            binary_path = f"{static_binary_directory}/{binary.name}"
-            amd64_download_command = (
-                f"curl {amd64_url} -o {binary_path} -L && chmod +x {binary_path}"
-                if amd64_url is not None
-                else "echo 'amd64 binary not available' && exit 1"
-            )
-            arm64_download_command = (
-                f"curl {arm64_url} -o {binary_path} -L && chmod +x {binary_path}"
-                if arm64_url is not None
-                else "echo 'arm64 binary not available' && exit 1"
+            template = self.jinja.get_template("binary_install.sh.j2")
+            render = template.render(
+                binary=binary,
+                amd64_url=amd64_url,
+                arm64_url=arm64_url,
+                binary_path=binary_path,
+                static_binary_directory=static_binary_directory,
             )
-
-            binary_cmd += (
-                '([[ "$(echo "$(arch)")" == "x86_64" ]] && {} || {}) && '.format(
-                    amd64_download_command, arm64_download_command
-                )
+            self._add_to_mounted_files(
+                hooks,
+                mounted_files,
+                "before_init",
+                f"binary_install_{binary.name}.sh",
+                render,
             )
 
-        if binary_cmd != "":
-            binary_cmd += "cd /mnt/workspace/source/$TF_VAR_spacelift_project_root"
-
-        hooks["before_init"].append(binary_cmd)
-        return None
-
     def get_plugin_binaries(self) -> Optional[List[Binary]]:
         """Get binary definitions from the plugin class."""
         return getattr(self.plugin_class, "__binaries__", None)

{spaceforge-0.0.3 → spaceforge-0.0.5}/spaceforge/plugin.py

@@ -233,7 +233,7 @@ class SpaceforgePlugin(ABC):
             data: Dict[str, Any] = json.load(f)
             return data
 
-    def send_markdown(self, markdown: str) -> None:
+    def send_markdown(self, markdown: str) -> bool:
         """
         Send a markdown message to the Spacelift run.
 
@@ -245,13 +245,13 @@ class SpaceforgePlugin(ABC):
                 "Spacelift run is local. Not uploading markdown. Below is a preview of what would be sent"
             )
             self.logger.info(markdown)
-            return
+            return True
 
         if self._spacelift_markdown_endpoint is None:
             self.logger.error(
                 'API is not enabled, please export "SPACELIFT_API_TOKEN" and "TF_VAR_spacelift_graphql_endpoint".'
             )
-            exit(1)
+            return False
 
         headers = {"Authorization": f"Bearer {self._api_token}"}
         body = {
@@ -263,28 +263,33 @@ class SpaceforgePlugin(ABC):
             self._spacelift_markdown_endpoint,
             json.dumps(body).encode("utf-8"),
             headers,
+            method="POST",
         )
 
-        with urllib.request.urlopen(req) as response:
-            if response.status != 200:
-                self.logger.error(
-                    f"Error getting signed URL for markdown upload: {response.status}"
-                )
-                return
-
-            raw_response = response.read().decode("utf-8")
-            self.logger.debug(raw_response)
-            resp: Dict[str, Any] = json.loads(raw_response)
-            if "url" not in resp or "headers" not in resp:
-                self.logger.error(
-                    "Markdown signed url response does not contain 'url' or 'headers' key."
-                )
-                return
+        try:
+            with urllib.request.urlopen(req) as response:
+                if response.status != 200:
+                    self.logger.error(
+                        f"Error getting signed URL for markdown upload: {response}"
+                    )
+                    return False
+
+                raw_response = response.read().decode("utf-8")
+                self.logger.debug(raw_response)
+                resp: Dict[str, Any] = json.loads(raw_response)
+                if "url" not in resp or "headers" not in resp:
+                    self.logger.error(
+                        "Markdown signed url response does not contain 'url' or 'headers' key."
+                    )
+                    return False
 
-            signed_url = resp["url"]
-            headers = resp["headers"]
-            headers["Content-Type"] = "text/markdown"
-            headers["Content-Length"] = str(len(markdown))
+                signed_url = resp["url"]
+                headers = resp["headers"]
+                headers["Content-Type"] = "text/markdown"
+                headers["Content-Length"] = str(len(markdown))
+        except urllib.request.HTTPError as e:
+            self.logger.error(f"HTTP error occurred: {e.code} - {e.reason}")
+            return False
 
         # Now we upload the markdown content to the signed URL
         req = urllib.request.Request(
@@ -299,8 +304,9 @@ class SpaceforgePlugin(ABC):
                 self.logger.error(
                     f"Error uploading markdown content: {put_response.status}"
                 )
-                return
+                return False
             self.logger.debug("Markdown content uploaded successfully.")
+        return True
 
     def add_to_policy_input(self, input_name: str, data: Dict[str, Any]) -> None:
         """