Scripts to Rule Them All

diagram.txt

   +----------------------------------------+
   |script/cibuild                          |
   |  build and test on CI server           |
   |                                        |
   |  * calls script/test                   |
   |  * sets environment variables for CI   |
   |                                        |
   +----------------------------------------+
                       |
                       |
                       |
   +-------------------v--------------------+      +---------------------------+      +----------------------------------------+
   |script/test                             |      |script/server              |      |script/console                          |
   |  run the test suite                    |      |  start the application    |      |  open a console                        |
   |                                        |      |                           |      |                                        |
   |  * If in test mode, calls script/setup |      |  * calls script/update    |      |  * Should accept a mode parameter      |
   |  * Otherwise, calls script/update      |      |                           |      |  * May call script/update              |
   |                                        |      |                           |      |                                        |
   +----------------------------------------+      +---------------------------+      +----------------------------------------+
                      |          |                                          |               |
                      |  - or -  +------------------------------------+     |               |
                      |                                               |     |               |
                  +---v------------------------------------+      +---v-----v---------------v--------------+
                  |script/setup                            |      |script/update                           |
                  |  sets up project to initial state      |      |  update the project after a fresh pull |
                  |                                        |      |                                        |
                  |  * after clone                         |      |  * calls script/bootstrap              |
                  |  * project reset                       |      |  * run database migrations             |
                  |  * calls script/bootstrap              |      |                                        |
                  |  * setup DBs                           |      |                                        |
                  +----------------------------------------+      +----------------------------------------+
                                      |                                                       |
                                      |                                                       |
                                      |                                                       |
                                      |           +----------------------------------+        |
                                      |           |script/bootstrap                  |        |
                                      |           |  fulfill project dependencies    |        |
                                      |           |                                  |        |
                                      +----------->  * nvm, rbenv                    <--------+
                                                  |  * Homebrew                      |
                                                  |  * npm install, bundler install  |
                                                  |  * git submodules                |
                                                  |                                  |
                                                  +----------------------------------+

See: github/scripts-to-rule-them-all