Do not print project configuration on every invocation

Open
#2,140 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
cli, tooling

Research direction

Start at the BuildStream CLI entry point and trace where the effective project configuration is printed during a normal invocation. Compare the proposed --print-configuration and --verbose behaviors, then verify that ordinary terminal output is quieter while an explicit flag still shows the configuration, including the CI use case.

Written by the indexing model from the issue text.

Description

enhancement frontend logging

While showing the effective configuration bst is running in can be a useful debugging tool, it really clutters the tool's output and most of the times scrolls by too fast to evaluate anyway. When using bst on a terminal it really adds to the clutter of printed output and making it really hard to scroll to navigate anywhere in that shell.

IMHO it should be shown only when a flag like --print-configuration or just --verbose is given and not otherwise.

I can understand why it is useful for CI environments to always show it, but for those cases I feel like it should just be controlled by the verbose flag and CI environments should configure that.

Dominant language
Python
Stars
144
Forks
45
Avg merge
20h 38m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/buildstream

All issues in apache/buildstream

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.