Skip to content

Commit 967f250

Browse files
authored
README: Mermaid graph to better explain Bob (#43)
the graph shows relationships between different CI systems to Bob, local build and local dev use cases and how they all layer on top of Docker
1 parent 51e6c7f commit 967f250

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,31 @@ Think like GitHub actions, but actually runnable locally (and also runnable from
1212

1313
Note: while Bob uses containers for builds (and dev), your programs themselves don't need to use containers!
1414

15+
16+
In a nutshell
17+
-------------
18+
19+
```mermaid
20+
flowchart TD
21+
GitHub[GitHub actions] --> Build_from_ci[Build from CI]
22+
GitLab[GitLab CI] --> Build_from_ci
23+
OtherCI[... CI] -->|In each CI: small boilerplate\nCI-specific conf to ask\nBob to do the build| Build_from_ci
24+
Build_from_ci -->|$ bob build in-ci-autodetect-settings| TurboBob
25+
Build_locally[Build locally] -->|$ bob build| TurboBob
26+
Develop_locally[Develop locally] -->|$ bob dev| TurboBob
27+
TurboBob[Turbo Bob<small>\ncontainer-based\nbuild orchestration</small>] -->|$ docker run ...| Docker
28+
```
29+
30+
Notes:
31+
32+
- Here's what the [GitHub actions boilerplate](https://github.com/function61/turbobob/blob/8ced488edb65fd99c718586a56ecdf5882307c70/.github/workflows/build.yml#L14) looks like for just passing the build to Bob
33+
* You can think of these as CI-specific adapters for passing control to Turbo Bob
34+
- Then [here's the container image that gets run to do the build](https://github.com/function61/turbobob/blob/51e6c7f5c5b0e7b0c244d670410e6c1a383429a6/turbobob.json#L9)
35+
* This is reusable container to build all our Go-based projects, i.e. the build environment can be shared across many projects. Ship one improvement to the build environment -> many projects benefit.
36+
37+
Small demo screencast
38+
---------------------
39+
1540
![](docs/demo-screencast.gif)
1641

1742

0 commit comments

Comments
 (0)