diff --git a/README b/README index 08f8519..a6b3625 100644 --- a/README +++ b/README @@ -1,3 +1,59 @@ Stick is the continuous integration testing suite for Kolab Groupware +Drydocker +========= + + For execution under Phabricator/Herald/Harbormaster/Drydock, with + help of leased hosts that can run Docker containers. + +This script should be executed in a leased Drydock host resource (which +you can limit to platform Atomic), such that a drydock worker user can +execute: + + + $ drydocker \ + --id "${build.id}" \ + --commit "${buildable.commit}" \ + --differential "${buildable.revision}" \ + --phid "${target.phid}" \ + --uri "${repository.uri}" \ + --vcs "${repository.vcs}" + +The `drydocker` script is supposed to; + + * Derive the package for which the script is executed, using the + source code management repository URI passed on by `--uri`. + + * Based on the package name, make some semi-intelligent decisions. + + Such decisions may include replacing `drydocker` itself, should it + be concluded the package is #stick. + +Future Options +============== + +`--platforms "platform1 platform2 ..."` + + List zero or more names of Docker images to use for continuous + integration. + +`--build` + + Execute build tests only. + +`--functional` + + Execute functional tests only. + +`--integration` + + Execute integration tests only. + +`--performance` + + Execute performance tests only. + +`--unit` + + Execute unit tests only.