Update GitOps repository

Default mode

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.

Replacer mode

There are situation when simple templating is not sufficient (e.g.: 100 LOC config files). Replacer mode solves this issue by replacing values that match the provided key-delimiter combinations.

Example

Example: We have a long config file that has the following line: us.gcr.io/ip-kubernetes-dev/hello-world-service:tag1 We would like to replace tag1 by tag2 without creating a template. We can use the step in "Replacer mode", by defining us.gcr.io/ip-kubernetes-dev/hello-world-service as key, and : as delimiter. The step will match & replace tag1 based on the provided key-delimiter combination.

When replacer_mode is enabled, values expects input a bit differently. To achieve the desired outcome above of the above example, one could use the following step inputs:

inputs:
  - deploy_repository_url: $DEPLOY_REPO_URL
  - deploy_path: $DEPLOY_PATH
  - pull_request: true
  - deploy_user: $DEPLOY_USER
  - deploy_branch: $BRANCH
  - replacer_mode: true
  - delimiter: ":"
  - files: 
      - example_config_file.yaml
  - values: |
      us.gcr.io/ip-kubernetes-dev/hello-world-service: tag2

In this case the step will look for maches in example_config_file.yaml, where the full path is $DEPLOY_PATH/example_config_file.yaml.

Caveats

In Replacer mode, the step matches values up until the first comma, exclamation mark, single quote or double quote.

Development

How to test this Step

0. Clone this repo
1. Set up .bitrise.secrets.yml file with the following content:

envs:
  - DEPLOY_TOKEN: YOUR PAT
  - MY_STEPLIB_REPO_FORK_GIT_URL: YOUR FORK HTTP URL OF THE STEPLIB REPO

2. Export these variables in your terminal
   • $DEPLOY_USER: your GH username
   • $DEPLOY_REPO_URL: Where to test commit, e.g. https://github.com/bitrise-io/sandbox-deployments.git
   • $DEPLOY_PATH: An existing folder in that repo, e.g. zsolt-test
3. Run bitrise run test which will open a PR
4. Confirm the PR is opened but close it

How to release

1. Merge the PR
2. Create a new release / tag
3. Fork the steplib https://github.com/bitrise-io/bitrise-steplib
4. Set YOUR fork steplib URL in the secrets file (see above)
5. Export the step version $BITRISE_STEP_VERSION in your terminal, without the prefix v
6. Run bitrise run share-this-step
7. Go to your forked steplib and create a PR
8. Get someone to review your PR and merge it