You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/jira/README.md
+55Lines changed: 55 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,6 +179,61 @@ For detailed technical information about the JIRA helper application, including:
179
179
180
180
Please refer to the [helper directory README](helper/README.md).
181
181
182
+
183
+
### **How It Works: A Step-by-Step Breakdown**
184
+
185
+
#### **1\. Build Helper Application**
186
+
187
+
The workflow begins by setting up Go and compiling the custom `helper/main.go` application. This binary contains all the logic for parsing git commits and interacting with the Jira API.
188
+
189
+
```
190
+
# In directory examples/jira/helper
191
+
chmod +x build.sh
192
+
./build.sh
193
+
```
194
+
195
+
---
196
+
197
+
#### **2\. Build and Publish Docker Image**
198
+
199
+
Next, a sample Docker image is built and pushed to Artifactory. The workflow captures rich build information, including git context and environment variables, using `jf rt build-publish`.
This is the core logic step. The compiled Go helper is executed, using the `start_commit` provided at runtime to define a range of git commits to scan. The application extracts all matching Jira IDs, queries the Jira API for their details, and generates the `transformed_jira_data.json` and optional Markdown report.
213
+
214
+
```
215
+
# In directory examples/jira/helper
216
+
./main "${{ github.event.inputs.start_commit }}"
217
+
```
218
+
219
+
---
220
+
221
+
#### **4\. Attach Signed Evidence to Build**
222
+
223
+
This final step uses `jf evd create --build-name` to attach the Jira ticket summary to the **build information** that was published in step 2\. This creates a verifiable link between the CI process itself and the project management tickets that authorized the code changes within it.
0 commit comments