Skip to content

docs: README diagram of the download / directory dispatch chain #312

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
igorpecovnik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: README diagram of the download / directory dispatch chain #312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,40 @@ Monitor all automation workflows with real-time status tracking:
- **Live status** — Current state of running CI/CD pipelines and scheduled tasks
- **Debugging tools** — Detailed logs and error traces for failed workflows

### Download / directory dispatch chain

How a fresh release ripples through the automation. Solid arrows fire; the dotted arrow is intentionally suppressed by GitHub's `GITHUB_TOKEN` same-repo guard (it's the loop-breaker — without it, `redirector ↔ download-index` would cycle forever).

```mermaid
flowchart TD
manual([manual workflow_dispatch / schedule]):::ext
sdk[armbian/sdk<br/>Build Armbian SDK]:::ext

manual --> dl
manual --> redir
manual --> dir
sdk -. repository_dispatch<br/>'Data: Update download index' .-> dl

subgraph ghio [armbian/armbian.github.io]
dl[Data: Generate Armbian download index]:::wf
redir[Infrastructure: Update CDN redirector]:::wf
dir[Web: Generate github.armbian.com content]:::wf
syncDispatch[Infrastructure: Dispatch website sync]:::wf

dl -- repository_dispatch<br/>'Infrastructure: Update redirector' --> redir
dl == commit to data branch ==> dir
redir == commit to data branch ==> dir
redir -. GITHUB_TOKEN suppressed<br/>'Data: Update download index' .-> dl

dir -- workflow_run completed --> syncDispatch
end

syncDispatch -- repository_dispatch<br/>'sync' --> websiteSync
websiteSync[armbian/website<br/>Website: Trigger data sync]:::ext

classDef ext fill:#f5f5f5,stroke:#999,color:#333,font-style:italic;
classDef wf fill:#e0f2fe,stroke:#0369a1,color:#0c4a6e;
```

Beyond this chain, several smaller producers (`data-update-image-info`, `data-update-base-files-info`, `data-update-jira-excerpt`, `data-update-partners-data`, `generate-build-lists`, `generate-keyring-data`, `generate-servers-jsons`, `generate-torrent-tracker-lists`, `repository-status`) all dispatch `Web: Directory listing` via `GITHUB_TOKEN`. Those dispatches are suppressed by the same-repo guard — `generate-web-directory` regenerates from the underlying `data` branch push instead.

Loading