Skip to content
Permalink
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

batect.dev/docs/concepts/includes-and-bundles.md

Go to file
 
 
Cannot retrieve contributors at this time
File includes Git includes See also
29 lines (19 sloc) 1.3 KB
Raw Blame
Open in GitHub Desktop
title
Includes and bundles

Includes allow you to import configuration defined elsewhere into your project. They are a useful mechanism for a number of situations:

  • to keep configuration files small and manageable
  • to share tasks and containers between projects
  • to take advantage of tasks and containers built and maintained by others, saving you time and effort

There are two main forms of includes: file includes and Git includes. Git includes allow you to include a bundle of configuration.

File includes

As the name suggests, file includes import a single file into your project. These are primarily used to split a large configuration file into smaller, more manageable pieces.

Git includes

Git includes import configuration from a bundle defined in a Git repository. This allows you to share configuration within your team or organisation, or take advantage of publicly-available bundles.

A bundle can be any Git repository containing a Batect configuration file. By default, this file is called batect-bundle.yml and follows the same format as an ordinary configuration file.

See also