Skip to content

Commit dc9ac49

Browse files
committed
Use Atlassian Document Format in description
1 parent ce881f2 commit dc9ac49

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

tools/flakeguard/cmd/create_jira_tickets.go

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ func rowToFlakyTicket(row []string) FlakyTicket {
204204

205205
summary := fmt.Sprintf("Fix Flaky Test: %s (%s%% flake rate)", testName, flakeRate)
206206

207-
// parse logs
207+
// Parse logs (same as before)
208208
var logSection string
209209
if logs == "" {
210210
logSection = "(Logs not available)"
@@ -216,7 +216,8 @@ func rowToFlakyTicket(row []string) FlakyTicket {
216216
if link == "" {
217217
continue
218218
}
219-
lines = append(lines, fmt.Sprintf("- [Run %d](%s)", runNumber, link))
219+
// Build a Jira wiki bullet for each log link
220+
lines = append(lines, fmt.Sprintf("* [Run %d|%s]", runNumber, link))
220221
runNumber++
221222
}
222223
if len(lines) == 0 {
@@ -226,21 +227,21 @@ func rowToFlakyTicket(row []string) FlakyTicket {
226227
}
227228
}
228229

229-
desc := fmt.Sprintf(`
230-
## Test Details:
231-
- **Package:** %s
232-
- **Test Name:** %s
233-
- **Flake Rate:** %s%% in the last 7 days
230+
// Use Jira Wiki Markup rather than Markdown
231+
desc := fmt.Sprintf(`h2. Test Details:
232+
* *Package:* %s
233+
* *Test Name:* %s
234+
* *Flake Rate:* %s%% in the last 7 days
234235
235-
### Test Logs:
236+
h3. Test Logs:
236237
%s
237238
238-
### Action Items:
239-
1. **Investigate:** Review logs to find the root cause.
240-
2. **Fix:** Address the underlying problem causing flakiness.
241-
3. **Rerun Locally:** Confirm the fix stabilizes the test.
242-
4. **Unskip:** Re-enable test in the CI pipeline once stable.
243-
5. **Ref:** Follow guidelines in the Flaky Test Guide.
239+
h3. Action Items:
240+
# *Investigate:* Review logs to find the root cause.
241+
# *Fix:* Address the underlying problem causing flakiness.
242+
# *Rerun Locally:* Confirm the fix stabilizes the test.
243+
# *Unskip:* Re-enable test in the CI pipeline once stable.
244+
# *Ref:* [Follow guidelines in the Flaky Test Guide|https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/tools/flakeguard/e2e-flaky-test-guide.md].
244245
`,
245246
pkg,
246247
testName,
@@ -569,7 +570,7 @@ func (m model) View() string {
569570
}
570571

571572
return fmt.Sprintf(
572-
"%s\n%s\n%s\n%s%s%s%s\n%s\n",
573+
"%s\n%s\n%s\n%s\n%s%s%s\n%s\n",
573574
header,
574575
sum,
575576
sumBody,

0 commit comments

Comments
 (0)