From 8ced488edb65fd99c718586a56ecdf5882307c70 Mon Sep 17 00:00:00 2001 From: "joonas.fi" Date: Thu, 11 May 2023 16:39:07 +0300 Subject: [PATCH 1/3] README: add mermaid graph to better explain Bob 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 --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 9846fc3..2c7f79f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,25 @@ Think like GitHub actions, but actually runnable locally (and also runnable from Note: while Bob uses containers for builds (and dev), your programs themselves don't need to use containers! + +In a nutshell +------------- + +```mermaid +flowchart TD + GitHub[GitHub actions] --> Build_from_ci[Build from CI] + GitLab[GitLab CI] --> Build_from_ci + Travis[Travis CI] --> Build_from_ci + OtherCI[... CI] -->|In each CI: small boilerplate\nCI-specific conf to ask\nBob to do the build| Build_from_ci + Build_from_ci -->|$ bob build in-ci-autodetect-settings| TurboBob + Build_locally[Build locally] -->|$ bob build| TurboBob + Develop_locally[Develop locally] -->|$ bob dev| TurboBob + TurboBob[Turbo Bob\ncontainer-based\nbuild orchestration] -->|$ docker run ...| Docker +``` + +Small demo screencast +--------------------- + ![](docs/demo-screencast.gif) From db41f3a1accb59806426c836566b9c8ab4e8df7f Mon Sep 17 00:00:00 2001 From: "joonas.fi" Date: Fri, 12 May 2023 12:04:24 +0300 Subject: [PATCH 2/3] README: add notes to `In a nutshell` graph --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2c7f79f..70b5b55 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,13 @@ flowchart TD TurboBob[Turbo Bob\ncontainer-based\nbuild orchestration] -->|$ docker run ...| Docker ``` +Notes: + +- 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 + * You can think of these as CI-specific adapters for passing control to Turbo Bob +- Then [here's the container image that gets run to do the build](https://github.com/function61/turbobob/blob/51e6c7f5c5b0e7b0c244d670410e6c1a383429a6/turbobob.json#L9) + * 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. + Small demo screencast --------------------- From 161e58f9fc22b534c9624f9239b8e453b9bfc5ae Mon Sep 17 00:00:00 2001 From: "joonas.fi" Date: Fri, 19 May 2023 22:22:56 +0300 Subject: [PATCH 3/3] remove stupid Travis --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 70b5b55..079219a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ In a nutshell flowchart TD GitHub[GitHub actions] --> Build_from_ci[Build from CI] GitLab[GitLab CI] --> Build_from_ci - Travis[Travis CI] --> Build_from_ci OtherCI[... CI] -->|In each CI: small boilerplate\nCI-specific conf to ask\nBob to do the build| Build_from_ci Build_from_ci -->|$ bob build in-ci-autodetect-settings| TurboBob Build_locally[Build locally] -->|$ bob build| TurboBob