No instructions to use BuildStream from master
Summary
As also outlined at BuildGrid/buildbox/buildbox-common#15 (seems that buildbox-common
and buildbox-casd
are also lacking documentation on how to obtain dependencies and install), since the recent move to buildbox-casd
, it is no longer clear how to run BuildStream master on your host, or even how to run tox
locally to run the tests.
Steps to reproduce
Be a user or developer and update your branch to master
, now try to do anything, like running BuildStream or the tests under tox
.
What is the current bug behavior?
The tests break because there is no buildbox-casd
in the PATH
.
What is the expected correct behavior?
BuildStream works, or provides you with documentation to make it work (of course "just working" is often preferable if it can be managed).
Possible fixes
Amend the CONTRIBUTING.rst
with a clear explanation of:
- What dependencies you will need from your distro, e.g. the grpc C++ stuff
- What dependencies you will need to build and install manually, e.g.
buildbox-common
andbuildbox-casd
projects - Links to documentation on how to install the required dependencies
- Probably some documentation about what branch of the buildbox projects should be used
- Would be nice to have some recommendation about using a local user specific install prefix for these, like
${HOME}/.local