-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for "--report file.md" flag to generate build report in markdown #106
Conversation
cannot start job - please talk to whoever's in charge of your Werft installation |
(Example for succesful build) Leeway build for
|
(Example for failing build) Leeway build for
|
Codecov Report
@@ Coverage Diff @@
## main #106 +/- ##
========================================
- Coverage 8.52% 8.31% -0.22%
========================================
Files 19 19
Lines 2850 2924 +74
========================================
Hits 243 243
- Misses 2571 2645 +74
Partials 36 36 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor change request about a typo, and a few other comments for you to consider
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small nit, otherwise LGTM
The report is rendered in Markdown and useful when using Leeway in environments that doen't support log cutting. For example: * Gitpod Workspaces * CI systems other than Werft
Description
This PR adds the ability to Leeway to generate a build report. See the following two comments for example reports.
To generate a report, run
leeway build
with the--report <filename>
flag. The report is in markdown format.This feature helps with the following use cases:
Log Cutting
Today, Leeway outputs the logs of concurrently running package builds in one intermixed stream of log messages. This report allows seeing log messages per component. This PR addresses this use case.
Build Hygiene
When there is a single build for all components from 40+ engineers, keeping the build fast requires regular housekeeping. For example, to keep dependencies sane and cache usage low. This PR does not address this use case yet, but a report is a great way to surface information related to build-hygiene. I see this as a complement to #80.
Related Issue(s)
Fixes https://github.com/gitpod-io/ops/issues/6450
How to test
Run
leeway build --report <filename>
on your favorite project.I did generate the examples by running
on the Gitpod repo.
Release Notes
Documentation