step.yml

title: Update GitOps repository
summary: |
  Updates files of a GitOps repository either by pushing changes directly to a
  given folder of a given branch or by opening a pull request to it.
description: |
  Updates files of a GitOps repository either by pushing changes directly to a
  given folder of a given branch or by opening a pull request to it.
  URL of the pull request is exposed as an output in the latter case.
  Updated files are go templates rendered by substituting given values.
  A Github username and Personal Access Token must be provided with access to the repository.
website: https://github.com/bitrise-io/bitrise-step-update-gitops-repository
source_code_url: https://github.com/bitrise-io/bitrise-step-update-gitops-repository
support_url: https://github.com/bitrise-io/bitrise-step-update-gitops-repository/issues
host_os_tags:
- osx-10.10
- ubuntu-16.04
type_tags:
- deploy

is_requires_admin_user: false
is_always_run: false
is_skippable: false
run_if: ""

deps:
  brew:
  - name: git
  apt_get:
  - name: git

toolkit:
  go:
    package_name: github.com/bitrise-io/bitrise-step-update-gitops-repository

inputs:
- deploy_repository_url: ""
  opts:
    title: Github HTTPS URL of the repository to deploy to
    is_required: true
- deploy_path: ""
  opts:
    title: Path to place rendered templates inside the repository
- deploy_token: $DEPLOY_TOKEN
  opts:
    title: Personal Access Token to interact with Github API
    is_sensitive: true
    is_required: true
- deploy_user: ""
  opts:
    title: Github username associated with the Personal Access Token
    is_required: true
- deploy_branch: "master"
  opts:
    title: Branch of the repository to deploy to
- commit_message: bitrise ci integration
  opts:
    title: Commit message of pushed changes
- templates_folder_path: deployments/helm
  opts:
    title: Path to Go templates folder
    category: Templates
- values: null
  opts:
    title: Input values for the Go template files in YAML format
    description: |-
      Input values for the Go template files as key-value pairs in YAML format.

      For example:

      ```
      my-key1: my value 1
      my-key2: my value 2
      ```

    category: Templates
- pull_request: false
  opts:
    title: Open a pull request
    category: Pull Request
    description: |
      Open a pull request instead of pushing
      changes directly to the given branch.
    value_options:
    - "true"
    - "false"
- pull_request_title: ""
  opts:
    title: Title of the opened pull request
    category: Pull Request
- pull_request_body: "Source commit: https://github.com/$BITRISEIO_GIT_REPOSITORY_OWNER/$BITRISEIO_GIT_REPOSITORY_SLUG/commit/$BITRISE_GIT_COMMIT"
  opts:
    title: Body of the opened pull request
    category: Pull Request
- replacer_mode: false
  opts:
    title: Key-value matching mode
    category: Replacer mode
    description: |
      There are situations when simple templating is not sufficient. 
      Replacer mode enables matching & replacing values based on a key+delimiter combination,
      across multiple files.
    value_options:
    - "true"
    - "false"
- delimiter: "="
  opts:
    title: Delimiter
    category: Replacer mode
    description: |
      Indicates the delimiter between key and value.
      For example in "key=value", "=" is the delimiter. 
      Required when "Replacer mode" is enabled.
- files:
  opts:
    title: Files
    category: Replacer mode
    description: |
      List of files to scan for matching key-value pairs.
      Required when "Replacer mode" is enabled.

outputs:
- PR_URL:
  opts:
    title: URL of opened pull request
    description: |
      URL of opened pull request. Will be emitted in pull request mode.