apache / apache/nuttx

Makes our CI more human readable

Open
#9,420 8 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
4k
Forks
1.7k
Avg merge
1d 17h
Merged PRs (30d)
237

Description

Currently we spend a lot of time trying to figure out why our CI is breaking. Unfortunately it is not human readable and I decided to open this issue to discuss how we could improve it to simplify our life or the life of ours contributors.

I have already some list of issues and suggestion to improve it based on my own experience that I will list below:

--------------------------------------------------------------------------------------------------------------------------------

Issue 1: We need to scroll all the way in the CI building log to find the issue.

Suggested solution: Create a summary of probably causes of the issue at the bottom of the log, it will simplify identifying the issue.

--------------------------------------------------------------------------------------------------------------------------------

Issue 2: CI doesn't explain what to do when board config is outdated

Suggestion: This issue is also related to "Issue 1" (because we need to scroll to find the issue), but it is now clear for new users wait is the issue and what they need to do.
For instance: if some defconfig isn't updated, they could be report in RED color at bottom: You forgot to update the board configs after you modification in the Kconfigs, please run the refresh.sh script.

--------------------------------------------------------------------------------------------------------------------------------

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the CI build logs and the board-config/Kconfig validation path, including the refresh.sh script mentioned in the issue. Define how failures should be summarized and what guidance should appear for outdated board configs, then verify the resulting CI output is understandable to new contributors.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, shell
Domain
build-system, ci-cd, embedded-iot
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.