Automated Dependency Updates for Vendir

Categories: no-category

Renovate supports updating Vendir dependencies.

File Matching

By default, Renovate will check any files matching the following regular expression: (^|/)vendir\.yml$.

For details on how to extend a manager's fileMatch value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: helm, docker.

Default config

{
  "commitMessageTopic": "vendir {{depName}}",
  "fileMatch": [
    "(^|/)vendir\\.yml$"
  ]
}

Additional Information

Renovate supports updating Helm Chart references and git references in vendir.yml via the vendir tool. Renovate requires the presence of a vendir lock file which is generated by vendir and should be stored in source code.

Helm Charts

It supports both https and oci helm chart repositories.

Example helm chart vendir.yml

apiVersion: vendir.k14s.io/v1alpha1
kind: Config

# one or more directories to manage with vendir
directories:
  - # path is relative to `vendir` CLI working directory
    path: config/_ytt_lib
    contents:
      path: github.com/cloudfoundry/cf-k8s-networking
      helmChart:
        # chart name (required)
        name: stable/redis
        # use specific chart version (string; optional)
        version: '1.2.1'
        # specifies Helm repository to fetch from (optional)
        repository:
          # repository url; supports exprimental oci helm fetch via
          # oci:// scheme (required)
          url: https://...
        # specify helm binary version to use;
        # '3' means binary 'helm3' needs to be on the path (optional)
        helmVersion: '3'

Registry Aliases

OCI

Aliases for OCI registries are supported via the dockerfile/docker manager

Git

Renovates supporting explicit refs in for git references in vendir.yml

Example git vendir.yml

apiVersion: vendir.k14s.io/v1alpha1
kind: Config

# one or more directories to manage with vendir
directories:
  - path: config/_ytt_lib
    contents:
      path: github.com/cloudfoundry/cf-k8s-networking
      git:
        # http or ssh urls are supported (required)
        url: https://github.com/cloudfoundry/cf-k8s-networking
        # branch, tag, commit; origin is the name of the remote (required)
        # optional if refSelection is specified (available in v0.11.0+)
        ref: origin/master
        # depth of commits to fetch; 0 (default) means everything (optional; v0.29.0+)
        depth: 1
        ...

GithubRelease

Renovates supporting explicit tags in for github releases in vendir.yml

Example github vendir.yml

directories:
  - path: config/_ytt_lib
    contents:
      path: github.com/cloudfoundry/cf-k8s-networking
      githubRelease:
        # slug for repository (org/repo) (required)
        slug: k14s/kapp-controller
        # use release tag (optional)
        # optional if tagSelection is specified (available in v0.22.0+)
        tag: v0.1.0