Show failed jobs in MR pipelines tab part 2
What does this MR do and why?
Add failed jobs tract to MR pipelines tab
Behind a FF we add the ability to see failed jobs trace directly inside the pipelines tab of a MR. Failed jobs are only fetched when clicking on the button to expand the table. Then each failed jobs is fetched and can be clicked on to expand the job log and see why the job failed.
IMPORTANT Feature specs will only be written either in the last MR or in a separate final MR. This is to avoid writing "temporary" feature specs while the feature is not fully functional.
This is part 2 of 5 in a series of MR!
In this MR, we introduce 1 key aspect:
- We are now fetching failed jobs via graphql and handling the toggling of the job list. For now, we are rendering only the job name
MR table:
Title | Link |
---|---|
Introduce FF and base component | !122914 (merged) |
Fetch failed jobs |
|
Display each failed job in a row with log | !122921 (merged) |
Add action button to each job row | !123086 (merged) |
Add polling when the widget is opened |
this is behind a disabled feature flag: ci_job_failures_in_mr
.
Preview
If you are wondering what it will look like after all the MRs are done, here is a quick preview of what the PoC looked like:
Screen_Recording_2023-06-05_at_3.18.34_PM
Screenshots or screen recordings
Before | After |
---|---|
x |
How to set up and validate locally
- Enable feature flag in rails console `Feature.enable(:ci_job_failures_in_mr)
- Make sure to have a functioning runner
- We need a MR with jobs failures. An easy to do so is to make a merge request on the ci config file and add explicit failures
- Navigate to
Build -> Pipeline Editor
- Change your config to include jobs failures like so:
my_failed_job:
script: exit 1
- Create a merge request with that change
- Navigate to the Merge request page
- Go to the pipelines page
- click "Show failed jobs
- Notice that failed jobs load and you can see their name!
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.