Skip to content

Docs add examples page #301

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
rklonner wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Docs add examples page #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cd2f30
Include new page in the navigation
rklonner Jan 4, 2026
07411d9
Add initial version of examples page
rklonner Jan 4, 2026
208ca81
Fix bullet points
rklonner Jan 4, 2026
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: 43 additions & 0 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Examples

The following examples are a selection of possible `argocd-diff-preview` use-cases and demonstrate the functionality of the tool. Every example has a [linked pull request in the repository](https://github.com/dag-andersen/argocd-diff-preview/pulls?q=is%3Apr+is%3Aopen+example) where `argocd-diff-preview` is executed to visualize the outcome as pull request comment.

## Collection
| Name | Task | Result |
|-|-|-|
| [example-helm-external-chart](https://github.com/dag-andersen/argocd-diff-preview/pull/15) | Modify the target revision of an ArgoCD application that deploys an external helm chart. Check what changed in the external helm chart by reviewing the rendered application. | `argocd-diff-preview` shows the differences of the helm chart that happend "under the hood". |
| [example-applicationset-refactoring](https://github.com/dag-andersen/argocd-diff-preview/pull/296) | Modify an existing applicationset and move from a List Generator to a Git Generator to derive the environments. Ensure your changes work by reviewing the rendered applications. | This example demonstrates a "Zero change" pull request, so the refactoring is successful when it yields the same ArgoCD applications. The analysis of `argocd-diff-preview` states **No changes found** which confirms the expected result. |

## Run the examples locally

**Prerequisites**

* Docker
* Git

You can play through the examples locally by setting the respective `TARGET_BRANCH` variable to point to an example branch

```bash
TARGET_BRANCH=example-applicationset-refactoring
```

and then execute the following commands:


```bash
TARGET_BRANCH=example-applicationset-refactoring

git clone https://github.com/dag-andersen/argocd-diff-preview base-branch --depth 1 -q

git clone https://github.com/dag-andersen/argocd-diff-preview target-branch --depth 1 -q -b $TARGET_BRANCH

docker run \
--network host \
-v /var/run/docker.sock:/var/run/docker.sock \
-v $(pwd)/output:/output \
-v $(pwd)/base-branch:/base-branch \
-v $(pwd)/target-branch:/target-branch \
-e TARGET_BRANCH=$TARGET_BRANCH \
-e REPO=dag-andersen/argocd-diff-preview \
dagandersen/argocd-diff-preview:v0.1.21
```
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ nav:
- Overview: index.md
- Demo: demo.md
- How it works: how-it-works.md
- Examples: examples.md
- Getting started:
- getting-started/github-actions-workflow.md
- getting-started/gitlab-cicd.md
Expand Down