Draft: update install instructions post bst2.0 release #1743
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Note that special container config is needed (particularly relevant when working with CI providers).
* Recommend distro packages where possible, and link to repology
* Install BuildStream before BuildBox, as the binary wheel packages
of BuildStream already contain BuildBox so it's not always necessary
to install BuildBox separately
Provide a 'recommended' list of host tools required by source plugins -
almost all real-world projects are using buildstream-plugins and the
`git` source, so we should mention this up-front.
Mention host tools required by BuildBox:
* If buildbox-run-bwrap isn't working, builds won't work.
* If buildbox-fuse cannot provide the CAS, then the BuildStream
sandbox is more limited in functionality and not all projects
can be built. (Specifically the buildbox-casd HardLinkStager
backend stages files in the source tree as read-only, but
some projects expect to be able to overwrite files in the
source tree during build commands).
Mention the install-time only dependencies required by Pip, if
prebuilt binary packages are not available for BuildStream and
the various dependencies (grpcio, protobuf, ujson, pyroaming)
that contain Cython and/or bundled C++ code.
Move this before "Installing BuildBox", as the latter may not be needed. Mention that BuildBox is bundled in the binary packages. Don't list the extra host dependencies here, refer back to previous section. BuildStream 2 is now "in beta", this sounds more complete than "dev snapshot". Clarify that pip `--editable` is optional, link to its documentation. Avoid referring to "pure Python" dependencies, at least 4 of BuildStream's Python dependencies contain Cython bundled and/or bundled C++. Avoid "simply", nothing in tech is ever simple :)
Reword intro, remove "now" and add info about the bundled binaries in wheel packages. Update buildbox-integration permalink info. Recommend use of latest stable tag, not some out of date versions.
Virtualenv users don't need to modify PATH, so change wording slightly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is to be merged after #1741 when the bst2.0 final release happens.