Skip to content
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

docs(readme): replace diagram with mermaid diagram #180

Merged
merged 3 commits into from
Sep 5, 2023
Merged

docs(readme): replace diagram with mermaid diagram #180

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2dced19
docs(readme): replace diagram with mermaid diagram
shini4i Sep 5, 2023
210e1a5
formatting fix
shini4i Sep 5, 2023
a2989dd
typo fix
shini4i Sep 5, 2023
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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,22 @@ The workflow for deployment might be the following
<details>
<summary>A simplified diagram</summary>
<div align="center">
<img src="https://raw.githubusercontent.com/shini4i/assets/main/src/argo-watcher/simplified_diagram.png" alt="Showcase" height="540" width="540">

```mermaid
graph TD
Dev[Dev] --> Commit{Commit changes to the git repository}
Commit --> Pipeline[Build pipeline triggered]
Pipeline --> Docker[Docker image built and published]
Docker --> Task[Pipeline adds a task to Argo-Watcher]
Task --> Check[Argo-Watcher checks Argo CD Api for an update]
Check --> Decision{Is ArgoCD Application running on the expected image?}
Decision -->|Yes| Success[Pipeline is marked as a success]
Decision -->|No| Retry[Check API again]
Retry --> TimeoutDecision{Has pre-defined timeout elapsed?}
TimeoutDecision -->|Yes| Failed[Pipeline is marked as failed]
TimeoutDecision -->|No| Check
```

</div>
</details>

Expand Down