Buckaroo has integration with leading Git hosting providers, which allows for recipes to exist directly in source-control. To use a hosted project as a recipe, the following conditions must be met:
- The project must have at least one tag, which is a semantic version (e.g. "v1.0")
- The project must contain a
buckaroo.jsonfile at the root level.
If you would like to create a recipe from a project, see :doc:`the packaging guide <package-guide>`.
A GitHub dependency is referred to with the prefix github+. So, for example, to install LoopPerfect/neither you would run:
buckaroo install github+loopperfect/neitherBuckaroo will generate the Git URL from the project name and owner, fetch the repository and read the buckaroo.json file.
A BitBucket dependency is referred to with the prefix bitbucket+. So, for example, to install org/example you would run:
buckaroo install bitbucket+org/exampleA GitLab dependency is referred to with the prefix gitlab+. So, for example, to install org/example you would run:
buckaroo install gitlab+org/example
VCS-hosted recipes can even have transitive dependencies! These are specified using the usual syntax in the project file of the repository. When resolving dependencies, Buckaroo will read this project file to generate further recipes to resolve. Note that the lock file of the dependency is ignored, and the cookbook of the current system is used to resolve the dependencies of the recipe.
Once a VCS-hosted dependency has been resolved, the exact commit hash of the tag is written to the lock file. This means that future installations will use the same version that was resolved on the first install. If this version becomes unavailable later, the resolution process can be re-run to fetch the current available version.