Create Template Sync Config

proton_create_template_sync_config

R Documentation

Set up a template to create new template versions automatically by tracking a linked repository¶

Description¶

Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see create_repository.

When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User Guide.

Usage¶

proton_create_template_sync_config(branch, repositoryName,
  repositoryProvider, subdirectory, templateName, templateType)

Arguments¶

branch

[required] The repository branch for your template.

repositoryName

[required] The repository name (for example, myrepos/myrepo).

repositoryProvider

[required] The provider type for your repository.

subdirectory

A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.

templateName

[required] The name of your registered template.

templateType

[required] The type of the registered template.

Value¶

A list with the following syntax:

list(
  templateSyncConfig = list(
    branch = "string",
    repositoryName = "string",
    repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
    subdirectory = "string",
    templateName = "string",
    templateType = "ENVIRONMENT"|"SERVICE"
  )
)

Request syntax¶

svc$create_template_sync_config(
  branch = "string",
  repositoryName = "string",
  repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
  subdirectory = "string",
  templateName = "string",
  templateType = "ENVIRONMENT"|"SERVICE"
)