Argo Compare

A comparison tool for displaying the differences between applications in different Git branches

Example output of argo-compare with diff-so-fancy

General information

Caution

Starting from version 0.3.0 support for ARGO_COMPARE_DIFF_COMMAND was removed in favor of EXTERNAL_DIFF_TOOL

This tool will show what would be changed in the manifests rendered by helm after changes to the specific Application are merged into the target branch.

How to install

The binary can be installed using homebrew:

brew install shini4i/tap/argo-compare

How to use

The simplest usage scenario is to compare all changed files in the current branch with the target branch:

argo-compare branch <target-branch>

If you want to compare only specific file, you can use the --file flag:

argo-compare branch <target-branch> --file <file-path>

By default, argo-compare will print only changed files content, but if this behavior is not desired, you can use one of the following flags:

# In addition to the changed files, it will print all added manifests
argo-compare branch <target-branch> --print-added-manifests
# In addition to the changed files, it will print all removed manifests
argo-compare branch <target-branch> --print-removed-manifests
# Print all changed, added and removed manifests
argo-compare branch <target-branch> --full-output

To use an external diff tool, you can set EXTERNAL_DIFF_TOOL environment variable. Each file diff will be passed in a pipe to the external tool.

EXTERNAL_DIFF_TOOL=diff-so-fancy argo-compare branch <target-branch>

Additionally, you can try this tool using docker container:

docker run -it --mount type=bind,source="$(pwd)",target=/apps ghcr.io/shini4i/argo-compare:<version> branch <target-branch>

Password Protected Repositories

Using password protected repositories is a bit more challenging. To make it work, we need to expose JSON as an environment variable. The JSON should contain the following fields:

{
  "url": "https://charts.example.com",
  "username": "username",
  "password": "password"
}

How to properly expose it depends on the specific use case.

A bash example:

export REPO_CREDS_EXAMPLE={\"url\":\"https://charts.example.com\",\"username\":\"username\",\"password\":\"password\"}

Where EXAMPLE is an identifier that is not used by the application.

Argo Compare will look for all REPO_CREDS_* environment variables and use them if url will match the repoURL from Application manifest.

How it works

First, this tool will check which files are changed compared to the files in the target branch.
It will get the content of the changed Application files from the target branch.
It will render manifests using the helm template using source and target branch values.
It will get rid of helm related labels as they are not important for the comparison. (It can be skipped by providing --preserve-helm-labels flag)
As the last step, it will compare rendered manifest from the source and destination branches and print the difference.

Current limitations

Works only with Applications that are using helm repositories and helm values present in the Application yaml.
~~Does not support password protected repositories.~~

Roadmap

Add support for Application using git as a source of helm chart
Add support for providing credentials for password protected helm repositories
Add support for posting diff as a comment to PR (GitHub)/MR(GitLab)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

shini4i / argo-compare