Project

General

Profile

Actions

action #118582

closed

coordination #96596: [qe-core][CI] CI/CD and Coding style improvements

[qe-core][CI][timeboxed:24h] Provide automated feedback on PR's when one or more checks fail

Added by szarate over 1 year ago. Updated over 1 year ago.

Status:
Rejected
Priority:
Normal
Assignee:
Category:
Spike/Research
Target version:
Start date:
2022-10-13
Due date:
% Done:

0%

Estimated time:
Difficulty:
Sprint:
QE-Core: October Sprint (Sep 28 - Oct 26)

Description

We've all seen the problems when something fails in the CI, and have to spend some time trying to figure out what's broken, by using something like stiky-pull-request-comment we should be able to get some effective feedback, that helps the person who created the PR to understand what went wrong.

In an ideal world, we could be using something that provides a more verbose output like GitHub shows for RuboCop which could be applied for Tidy, or some of the other checks we have for things like yaml schedules, or coding rules.

https://github.com/marocchino/sticky-pull-request-comment

Suggestions

  1. Try out an alternative for comments either by directly writing code or by using marocchino/stiky-pull-request-comment as means to provide feedback on failing tests
  2. We don't necessarily need to use Perl for this solution.

Acceptance Criteria

  1. Possible alternatives are documented on this ticket
  2. Comments provide the name of the offending file, and line
Actions #1

Updated by VANASTASIADIS over 1 year ago

  • Status changed from New to In Progress
  • Assignee set to VANASTASIADIS
Actions #3

Updated by VANASTASIADIS over 1 year ago

  • Status changed from In Progress to Workable
  • Assignee deleted (VANASTASIADIS)

A few notes from my short tries:

  • marocchino/stiky-pull-request-comment works like a charm, but the problem is catching and handling the ci test results. The matrix approach used by the ci makes it harder to reference individual steps and jobs via id.

  • this is not a problem that is impossible to solve, but perhaps investing in amending the current ci tests to provide better/clearer output would be easier and preferred.

  • I will revisit at a later date if noone else comes picks this up. Feel free to experiment and propose other solutions.

Actions #4

Updated by szarate over 1 year ago

  • Status changed from Workable to Rejected
  • Assignee set to VANASTASIADIS

Rejecting in favor of #118588

Actions

Also available in: Atom PDF