Merge branch 'mokhax/406633-explain-vuln-with-markdown' into 'master'

Format explain vulnerability responses with markdown format headers

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117902



Merged-by: George Koltsov <gkoltsov@gitlab.com>
Approved-by: Minahil Nichols <minahilnichols@gitlab.com>
Approved-by: George Koltsov <gkoltsov@gitlab.com>
Co-authored-by: mo khan <mo@mokhan.ca>

ee/lib/gitlab/llm/open_ai/templates/explain_vulnerability.rb

@@ -58,6 +58,7 @@ def default_prompt
 
             Provide a code example with syntax highlighting on how to exploit it.
             Provide a code example with syntax highlighting on how to fix it.
+            Provide the response in markdown format with headers.
             PROMPT
           end
 
@@ -68,6 +69,7 @@ def prompt_without_code
             The vulnerable code is in the file "#{filename}".
             Provide a code example with syntax highlighting on how to exploit it.
             Provide a code example with syntax highlighting on how to fix it.
+            Provide the response in markdown format with headers.
             PROMPT
           end
 
@@ -77,6 +79,7 @@ def prompt_without_file_or_code
             Explain the vulnerability "#{title} - #{description} (#{identifiers})".
             Provide a code example with syntax highlighting on how to exploit it.
             Provide a code example with syntax highlighting on how to fix it.
+            Provide the response in markdown format with headers.
             PROMPT
           end
         end

ee/spec/lib/gitlab/llm/open_ai/templates/explain_vulnerability_spec.rb

@@ -79,6 +79,7 @@
           The vulnerable code is in the file "#{vulnerability.file}".
           Provide a code example with syntax highlighting on how to exploit it.
           Provide a code example with syntax highlighting on how to fix it.
+          Provide the response in markdown format with headers.
           PROMPT
         end
       end
@@ -95,6 +96,7 @@
         Explain the vulnerability "#{vulnerability.title} - #{vulnerability.description} (#{identifiers})".
         Provide a code example with syntax highlighting on how to exploit it.
         Provide a code example with syntax highlighting on how to fix it.
+        Provide the response in markdown format with headers.
         PROMPT
 
         expect(subject.to_prompt).to eq(expected)