werf-includes.yaml | Reference

All the paths and globs in the config must be defined relative to the project directory.

0	includes:	# Configuration of remote git repositories for import
1	- git: string	# The address of the remote repository. More details here
2	basicAuth: string	# Basic authentication for the remote repository
3	- username: string	# Username
4	password: string	# Password source
5	- env: string	# Environment variable
6	src: string	# File path
7	value: string	# Custom string value
8	branch: string	# The name of the branch to import files from. Incompatible with the tag and commit directives
9	tag: string	# The name of the tag to import files from. Incompatible with the branch and commit directives
10	commit: string	# The commit hash to import files from. Incompatible with the branch and tag directives
11	add: string	# The path to the directory in the remote repository to import files from
12	to: string	# The path to the directory in the local repository to import files to
13	includePaths: [ glob, ... ]	# The paths to the files in the remote repository to import. If not specified, all files will be imported
14	excludePaths: [ glob, ... ]	# The paths to the files in the remote repository to exclude from import. If not specified, no files will be excluded

JSON Schema

The format of werf-includes.yaml is published as a JSON Schema at https://werf.io/docs/v3/schemas/werf-includes.json. Editors that support JSON Schema for YAML use it for completion, hover documentation and validation.

In VS Code with the YAML extension, add to .vscode/settings.json:

{
  "yaml.schemas": {
    "https://werf.io/docs/v3/schemas/werf-includes.json": ["werf-includes.yaml"]
  }
}

Alternatively, point to the schema from the file itself:

# yaml-language-server: $schema=https://werf.io/docs/v3/schemas/werf-includes.json