The Braid configuration file (.braids.json
) contains a configuration version
number that indicates the format of the configuration file and the Braid
features required by the project. You'll be directed to this page if you use a
version of Braid that does not support the project's configuration version; see
the readme for more information about
the versioning scheme.
To get a compatible version of Braid:
- First check if the project has its own instructions to install and run Braid, and if so, follow them instead.
- Look up the Braid versions corresponding to your current configuration version in the table below.
- Run
gem query --remote --all --exact braid
to get a list of all existing versions of Braid, and choose one that is compatible with your configuration version (you probably want the newest such version); call itx.y.z
. - Run
gem install braid --version x.y.z
to install the chosen version of Braid. - Run Braid as
braid _x.y.z_
(that's the chosen version surrounded by literal underscores) followed by your desired arguments.
Config. version | Braid versions | Changes since previous |
---|---|---|
1 | 1.1.x | (Various) |
"0" | (Braid versions earlier than 1.1.0 have varying configuration formats and features and do not have a well-defined compatibility scheme. Braid 1.1.0 and newer refer to all of these formats as version "0" and are capable of correctly upgrading most of them. We recommend upgrading to Braid 1.1.0 or newer if you can.) |