apache / apache/buildstream

RFE: Add `bst validate` command

Open
#638 15 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
140
Forks
45
Avg merge
1d 3h
Merged PRs (30d)
6

Description

[See original issue on GitLab](https://gitlab.com/BuildStream/buildstream/-/issues/638)
In GitLab by [[Gitlab user @cs-shadow]](https://gitlab.com/cs-shadow) on Sep 10, 2018, 13:32

## Background

This command would validate project, element and optionally user configurations. It will be useful to verify that all configs actually are valid before trying to build them. It will be especially useful for running under CI as a lightweight check for verifying the configs.

At the very least, this command would provide a yes/no kind of feedback for given config files, but ideally it may also try to detect common anti-patterns and report them.

## Task description

[//]: # (Short summary of the action to be executed)

* [ ] Add a top-level `bst` command to validate `*.bst` files

## Acceptance Criteria

[//]: # (Acceptance criteria should follow the S.M.A.R.T. principle https://en.wikipedia.org/wiki/SMART_criteria )

One is able to verify all element and project configuration using a single command.

----

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests. Start by locating the top-level `bst` command entry point and the existing validation paths for project, element, and optional user configuration; done means one command can validate all configurations and provide yes/no feedback.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.