Skip to content

docs: self-managed comby dev dependency install

Warren Gifford requested to merge rvt/comby-install-docs into master

Created by: rvantonder

This updates documentation for installing comby as a dependency. There are constraints that make updating comby automatically in the dev scripts hard. These are, roughly:

  • binary distribution for different OSes
  • rapid iteration that require faster distribution than available through OS package managers, and
  • effort or extra time required when using toolchains and dependencies for building from source

If you are interested in more nitty gritty detail, see the slack thread.

Thus, for development, comby will now be a self-managed install, and treated as an external dependency. It is in fact optional unless you work with automation tooling at this point in time. Nothing changes for CI or deployments. There are many options for installing it so that:

  • Developers who aren't reliant on comby for development are unaffected (i.e., no broken dev builds, ever, and this is the priority behind this change.)
  • Developers who are reliant on comby but not the most recent versions can use, e.g., brew or grab the binaries from GH and put it on their PATH.
  • Developers who are reliant on recent versions with bug fixes or feature extensions can grab it directly from GH if it's not available on brew yet.

Test plan: N/A, that's part of the objective.

Merge request reports

Loading