zendesk / action-vendir

A GitHub action to execute vendir

action-vendir

A GitHub action for executing vendir. Typical usage will be to

• vendor copies of a third party repo's files and create a PR to the local repo or
• vendor copies of a third party repo's files to use within another action

Inputs

• token - GitHub token to authenticate git clone requests. REQUIRED
• version - Version of vendir to install. OPTIONAL, defaults to latest
• locked - Whether or not vendir should be invoked with --locked option. OPTIONAL, defaults to "false"
• vendir_file - File that defines dependencies. OPTIONAL, defaults to vendir.yml
• working_dir - Working directory to switch to prior to installing and running vendir, defaults to "."
• target_dir - Target directory for the vendir process, defaults to "."

Output

This Action has no outputs.

Usage

Print to STDOUT

steps:
  - id: action-vendir
    uses: zendesk/action-vendir@v2
    with:
      token: ${{ secrets.github_token }}

Use vendir lock file

steps:
  - id: action-vendir
    uses: zendesk/action-vendir@v1
    with:
      token: ${{ secrets.github_token }}
      locked: true

Use a file other than vendir.yml

steps:
  - id: action-vendir
    uses: zendesk/action-vendir@v1
    with:
      token: ${{ secrets.github_token }}
      vendir_file: some_other_file.yml