feat(issuegenerator): link to specific failing job instead of workflow run#1552
feat(issuegenerator): link to specific failing job instead of workflow run#1552vyagh wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1552 +/- ##
==========================================
+ Coverage 64.13% 64.45% +0.31%
==========================================
Files 66 66
Lines 3424 3463 +39
==========================================
+ Hits 2196 2232 +36
- Misses 990 992 +2
- Partials 238 239 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2bd3c69 to
09d969e
Compare
mx-psi
left a comment
There was a problem hiding this comment.
We need to update the templates to reflect that we now have a list of failed issues instead of a single link
| return nil, err | ||
| } | ||
| for _, job := range jobs.Jobs { | ||
| if job.GetConclusion() == "failure" || job.GetConclusion() == "timed_out" { |
There was a problem hiding this comment.
Let's not add timed out as a reason, we know those are not the ones that caused a particular test case to fail
mx-psi
left a comment
There was a problem hiding this comment.
Let's add helper text on the template itself
|
As in, here: |
f46599b to
b1b217d
Compare
|
Hi @mx-psi |
mx-psi
left a comment
There was a problem hiding this comment.
Apologies for the delay on this. The main reason I don't feel comfortable merging this PR is because I don't think the failing jobs are on the right place on the issue template. I also worry that there could be too many failing tests and that the message feels 'spammy'.
I would rather keep the original link and have the failing jobs at the bottom of the issue body/comment in a collapsible section.
Since we are changing the issue template, we can also rename linkToBuild (or, rather, add a new field), that really reflects the information we are adding on the issue template (which as a list of links to failing jobs)
b1b217d to
c27856a
Compare
|
nw about the delay, here's what i did now:
|
| PR: ${prNumber} | ||
|
|
||
| ${failedTests} | ||
| ${failedTests}${failedJobs} |
There was a problem hiding this comment.
Since the details HTML code is fixed I would put it on the template:
| ${failedTests}${failedJobs} | |
| ${failedTests} | |
| <details> | |
| <summary>Failing job(s)</summary> | |
| ${failedJobs} | |
| </details> |
(same in the other template)
There was a problem hiding this comment.
updated, failedJobs now just returns the list items.
There was a problem hiding this comment.
btw the < details > is in the template now, it'll render an empty collapsible even when there are no failed jobs. are you fine with that?
…c workflow run This change modifies the issue generator to report individual failed jobs within a workflow run. This provides direct links to the relevant logs for faster debugging. - Filters for strictly 'failure' conclusions, ignoring noise like 'timed_out'. - Supports deterministic bulleted lists when multiple jobs fail. - Adds explicit prefix text to reports for improved clarity. - Includes unit tests for filtering logic and template rendering.
c27856a to
3c0494c
Compare
Description
Updates the
issuegeneratorto link directly to the failing job instead of the top-level workflow run summary. This saves maintainers time by taking them straight to the logs of the specific failure.If a failing job cannot be found (e.g logs expired or API error) or if the run failed immediately, it safely falls back to the existing behavior (linking to the run summary).
Changes
actions/runs/{id}/jobsAPI.${linkToBuild}.Issue
Fixes #1183
Testing
go test ./issuegenerator/...)