From fe66f36b87cf577a3f0dfbf282666ae47b2c42ac Mon Sep 17 00:00:00 2001
From: Tim Jacomb <timjacomb1@gmail.com>
Date: Wed, 4 Sep 2024 17:29:59 +0100
Subject: [PATCH] Document includeStage in snippet generator

---
 .../plugins/checks/steps/WithChecksStep/config.jelly        | 6 ++++++
 .../checks/steps/WithChecksStep/help-includeStage.html      | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/help-includeStage.html

diff --git a/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/config.jelly b/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/config.jelly
index 88b713b5..748cc976 100644
--- a/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/config.jelly
+++ b/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/config.jelly
@@ -5,4 +5,10 @@
     <f:textbox />
   </f:entry>
 
+  <f:advanced>
+    <f:entry title="${%Include stage}" field="includeStage">
+      <f:checkbox />
+    </f:entry>
+  </f:advanced>
+
 </j:jelly>
diff --git a/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/help-includeStage.html b/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/help-includeStage.html
new file mode 100644
index 00000000..ce1ff6bc
--- /dev/null
+++ b/src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/help-includeStage.html
@@ -0,0 +1 @@
+<p>Appends the stage name to the check, this can be useful when you have multiple types of tests in different stages</p>