From c323a569377373063112cf6d6bdf07ca865cb396 Mon Sep 17 00:00:00 2001 From: Scott Todd Date: Fri, 2 Aug 2024 11:33:36 -0700 Subject: [PATCH] Replace diagram image with mermaid, drop note about official actions. --- .../docs/developers/general/github-actions.md | 43 +++++++++++++++---- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/docs/website/docs/developers/general/github-actions.md b/docs/website/docs/developers/general/github-actions.md index 8b6ed9c1f88e..94d08ae1649b 100644 --- a/docs/website/docs/developers/general/github-actions.md +++ b/docs/website/docs/developers/general/github-actions.md @@ -17,14 +17,9 @@ automation (CI) and continuous delivery (CD) workflows: * Updating dependencies. Workflows are defined directly in the repository at -[`.github/workflows/`](https://github.com/iree-org/iree/tree/main/.github/workflows), -using a mix of official actions -(e.g. [actions/checkout](https://github.com/actions/checkout)), -community actions -(e.g. [pre-commit/action](https://github.com/pre-commit/action)), -and custom code. We use a mix of GitHub-hosted runners and self-hosted runners -to get automated build and test coverage across a variety of platforms and -hardware accelerators. +[`.github/workflows/`](https://github.com/iree-org/iree/tree/main/.github/workflows). +We use a mix of GitHub-hosted runners and self-hosted runners to get automated +build and test coverage across a variety of platforms and hardware accelerators. ### Terminology primer @@ -40,7 +35,37 @@ _(Read more on * _Events_ are specific activities in a repository that trigger a _workflow run_. - +```mermaid +graph + accTitle: Example workflow run diagram + accDescr { + An event runs two jobs - job 1 on runner 1 and job 2 on runner. + Job 1 runs four steps, each either an action or script. + Job 2 runs three other steps. + } + + event("Event") + + event --> runner_1 + event --> runner_2 + + subgraph runner_1["Runner 1"] + job_1("Job 1 + • Step 1: Run action + • Step 2: Run script + • Step 3: Run script + • Step 4: Run action + ") + end + + subgraph runner_2["Runner 2"] + job_2("Job 2 + • Step 1: Run action + • Step 2: Run script + • Step 3: Run script + ") + end +``` ## :material-list-status: Workflow descriptions and status