suggest_clone

info

This parameter can only be used inside of a git repository. Any global configuration for that parameter will be ignored.

Repositories that a git repository suggests should be cloned, this is picked up when calling omni up --clone-suggested or when this command is directly called by omni clone.

Parameters

Contains a list of objects with the following parameters:

Parameter	Type	Description
handle	string	The repository handle, corresponding to the URL allowing to clone the repository
args	string	The optional arguments to pass to the git clone command
clone_type	enum	Suggests how the repository should be cloned. Can be one of package or worktree, and generally defaults to cloning as packages when following suggestions.

Template

The suggest_clone parameter can be templated. The template needs to resolve to a list of objects with the parameters described above. You can template this parameter by using the following parameters:

Parameter	Type	Description
template_file	string	The path to the file containing the template to use. The path is relative to the root of the work directory.
template	string	The template to use.

Examples

# To suggest cloning the omni repository
suggest_clone:
  - git@github.com:XaF/omni

# To suggest cloning the omni repository, and the omni-example one
suggest_clone:
  - https://github.com/XaF/omni
  - handle: https://github.com/omnicli/omni-example

# If we want to suggest cloning the omni repository, but only with a depth of 1
suggest_clone:
  - handle: git@github.com:XaF/omni
    args: --depth 1

# We can suggest cloning the omni repository in the worktree
suggest_clone:
  - handle: git@github.com:XaF/omni
    clone_type: worktree

# We can also template the suggest_clone parameter using a template file
suggest_clone:
  template_file: .omni/suggest_clone.tmpl

# Or template the suggest_clone parameter using a template string
suggest_clone:
  template: |
    - {{ partial_resolve(handle="omni-example") }}
    {% if prompts.team == "team1" %}
    - {{ partial_resolve(handle="team1-tools") }}
    {% endif %}