Skip to content

[docs] added install method #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ponkio-o wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[docs] added install method #54

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e6ff2a1
added install method
ponkio-o Oct 26, 2024
2e1c46b
fix: added `aqua init`
ponkio-o Oct 28, 2024
a24b928
Update docs/installation.md
ponkio-o Nov 4, 2024
b4237b1
Merge branch 'main' into add-install-method
ponkio-o Nov 5, 2024
6f19ca9
chore: remove old section
ponkio-o Nov 5, 2024
b3892ef
chore: format
ponkio-o Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) OR [minikube](https://minikube.sigs.k8s.io/docs/start/)
- [Argo CD CLI](https://argo-cd.readthedocs.io/en/stable/cli_installation/)

## Find the correct binary for your operating system
## Download binary from GitHub releases

Check the [releases](https://github.com/dag-andersen/argocd-diff-preview/releases) and find the correct binary for your operating system.

Expand Down Expand Up @@ -121,3 +121,44 @@

If base-branch is not specified it will default to `main`.

=== "Aqua"

## Pre-requisites

Install:

- [Git](https://git-scm.com/downloads)
- [Docker](https://docs.docker.com/get-docker/)
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) OR [minikube](https://minikube.sigs.k8s.io/docs/start/)
- [Argo CD CLI](https://argo-cd.readthedocs.io/en/stable/cli_installation/)

## Install binary with [aquaproj/aqua](https://github.com/aquaproj/aqua)
`argocd-diff-preview` also supports installation by aqua. See [documentation](https://aquaproj.github.io/docs/install) for aqua setup instructions.

```bash
aqua init
aqua g -i dag-andersen/argocd-diff-preview
aqua i
argocd-diff-preview --help
```

## Usage

You need to pull down the two branches you want to compare. The first branch will be cloned into the `base-branch` folder, and the other branch will be cloned into the `target-branch` folder.

```bash
git clone https://github.com/<owner>/<repo> base-branch --depth 1 -q -b <branch-a>

git clone https://github.com/<owner>/<repo> target-branch --depth 1 -q -b <branch-b>
```

## Run the binary
```bash
argocd-diff-preview \
--repo <owner>/<repo-name> \
--base-branch <branch-a> \
--target-branch <branch-b>
```

If base-branch is not specified it will default to `main`.