Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas-Richard committed Dec 15, 2023
1 parent 60e0074 commit 89cb7d1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 21 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,27 @@ The rendered manifests are kept within the repository, making diffs between revi
---
## How it works:
1. A user makes their desired change to the application's templates (charts, overrides, etc) and submits a PR with the change.
2. A CI job executes `mani-diffy`, rendering all manifests affected by the change.
2. A Github action job executes `mani-diffy`, rendering all manifests affected by the change.
3. Any updated manifests are submitted back to the same PR as a new commit.
4. The author and any reviewers will be able to review the diff between the new changes and the previous version of the manifests.

# See it in action

🫵 Submit a PR where you make a change to the overrides of the [`demo`](demo/README.md), and you'll see the [Github action]( [README](../../.github/workflows/generate-manifests-demos.yaml)) add a commit to your PR with the resulting changes.

<img width="1099" alt="1" src="https://github.com/1debit/mani-diffy/assets/9005904/6b6d9e45-57f7-43ff-906f-ebf4c0a03ad9">
<img width="1701" alt="2" src="https://github.com/1debit/mani-diffy/assets/9005904/03d4a49e-1fc9-40a1-9882-1c032b2d345b">

# See it in action in a video !

In this screen recording a pull request is opened to make the following changes to the [`demo`](demo/README.md):

1. Bump the count of pods for the `foo` service in the prod cluster
2. Add an annotation to all services

https://github.com/1debit/mani-diffy/assets/9005904/6c496996-f7af-4932-bf5d-01a5b57bbd99


## Post Renderers

`mani-diffy` also supports something called a "post renderer". This is a command that will be called immediately after an Application is rendered. This can be used to run linting, or alter the output of the generated manifest.
Expand Down Expand Up @@ -51,7 +68,3 @@ You can see an example of that in the [`demo`](demo/README.md) directory.
Q: Is ArgoCD using the rendered manifests in `.zz.auto-generated` ?

A: No, ArgoCD renders the charts itself. There is no expected discrepancy between the manifest files rendered by mani-diffy and by ArgoCD as long as they are using the same version of Helm.




16 changes: 0 additions & 16 deletions demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,3 @@ graph TD;
test-service-baz-->test-baz-worker["baz Worker<br/>kind: Deployment"];
test-service-baz-->test-baz-web["baz Web<br/>kind: Deployment"];
```

# See it in action

Submit a PR where you make a change to the overrides and you'll see the [Github action]( [README](../../.github/workflows/generate-manifests-demos.yaml)) add a commit to your PR with the resulting changes.

<img width="1099" alt="1" src="https://github.com/1debit/mani-diffy/assets/9005904/6b6d9e45-57f7-43ff-906f-ebf4c0a03ad9">
<img width="1701" alt="2" src="https://github.com/1debit/mani-diffy/assets/9005904/03d4a49e-1fc9-40a1-9882-1c032b2d345b">

# See it in action in a video !

In this screen recording a pull request is opened to:

1. Bump the count of pods for the `foo` service in the prod cluster
2. Add an annotation to all services

https://github.com/1debit/mani-diffy/assets/9005904/6c496996-f7af-4932-bf5d-01a5b57bbd99

0 comments on commit 89cb7d1

Please sign in to comment.