Upload explain_error.py with huggingface_hub

explain_error.py

@@ -1,11 +1,33 @@
 # explain_error.py
 
 from extract_error_features import extract_error_features
+from retrieve_docs import retrieve_docs
+
+SYSTEM_PROMPT = """
+You are a Jenkins CI/CD expert.
+
+Explain the Jenkins error using ONLY the provided documentation context.
+If the documentation does not clearly explain the error, say so explicitly.
+
+Output format:
+
+Error Summary:
+<short explanation>
+
+Likely Causes:
+- cause 1
+- cause 2
+
+Relevant Documentation:
+- link or source file
+"""
 
 def explain_error(log_text: str):
     features = extract_error_features(log_text)
     category = features["category"]
 
+    retrieved = retrieve_docs(category)
+
     explanation = {
         "error_category": category,
         "summary": "",
@@ -23,10 +45,6 @@ def explain_error(log_text: str):
             "Missing or mismatched braces in the Jenkinsfile",
             "Invalid declarative pipeline structure"
         ]
-        explanation["references"] = [
-            "Pipeline Syntax Reference (Jenkins.io)",
-            "Declarative Pipeline Documentation"
-        ]
 
     elif category == "missing_agent":
         explanation["summary"] = (
@@ -37,10 +55,6 @@ def explain_error(log_text: str):
             "Using 'agent none' without defining a stage-level agent",
             "Executing node-dependent steps without a workspace"
         ]
-        explanation["references"] = [
-            "Agent Directive (Jenkins.io)",
-            "Pipeline Steps Documentation"
-        ]
 
     elif category == "no_node_available":
         explanation["summary"] = (
@@ -51,10 +65,6 @@ def explain_error(log_text: str):
             "The specified node label does not exist",
             "All matching nodes are offline or busy"
         ]
-        explanation["references"] = [
-            "Distributed Builds (Jenkins.io)",
-            "Node Label Plugin Documentation"
-        ]
 
     elif category == "missing_plugin":
         explanation["summary"] = (
@@ -65,10 +75,6 @@ def explain_error(log_text: str):
             "Required plugin is not installed",
             "Incorrect step name in the Jenkinsfile"
         ]
-        explanation["references"] = [
-            "Plugin Index",
-            "Pipeline Steps Reference"
-        ]
 
     elif category == "missing_credentials":
         explanation["summary"] = (
@@ -78,10 +84,6 @@ def explain_error(log_text: str):
             "Credentials ID is incorrect or misspelled",
             "Credentials were not configured in Jenkins"
         ]
-        explanation["references"] = [
-            "Credentials Plugin Documentation",
-            "Using Credentials in Pipelines"
-        ]
 
     elif category == "file_not_found":
         explanation["summary"] = (
@@ -92,10 +94,6 @@ def explain_error(log_text: str):
             "File path is incorrect",
             "File was not generated or checked out"
         ]
-        explanation["references"] = [
-            "Pipeline Basic Steps",
-            "Workspace Plugin Documentation"
-        ]
 
     elif category == "git_authentication_error":
         explanation["summary"] = (
@@ -105,23 +103,23 @@ def explain_error(log_text: str):
             "Invalid or missing Git credentials",
             "Repository requires token-based authentication"
         ]
-        explanation["references"] = [
-            "Git Plugin Documentation",
-            "Credential Binding Plugin"
-        ]
 
     else:
         explanation["summary"] = (
-            "The error could not be confidently identified. "
-            "Please check the error message for more details."
+            "The error could not be confidently explained using the available documentation."
         )
-        explanation["likely_causes"] = [
-            "Review the full error log",
-            "Check Jenkins system logs"
-        ]
-        explanation["references"] = [
-            "Jenkins Pipeline Troubleshooting Guide"
-        ]
+
+    for r in retrieved:
+        explanation["references"].append(
+            f"{r['meta']['source_file']} ({r['meta']['source']})"
+        )
+    if not retrieved:
+        explanation["summary"] = (
+            "No relevant Jenkins documentation was found for this error. "
+            "The error may be plugin-specific or outside the current scope."
+        )
+        explanation["likely_causes"] = []
+        explanation["references"] = []
 
     return explanation