From 14a719c8e88adf98bf6d40c49a652f2a1a4336cb Mon Sep 17 00:00:00 2001 From: Perttu Ehn Date: Mon, 15 Aug 2016 18:56:14 +0300 Subject: [PATCH 1/4] README.md improvements; add descriptions of all available scripts. --- README.md | 37 +++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4cd89ce..316e6cd 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,41 @@ need to argue with xdebug or get Drush installed. It's all built in! ## Use -1. Download Dropwhale and copy the .docker directory to the root of your module repository. +1. Download Dropwhale and copy the `.docker` directory to the root of your module repository. 2. You can choose to commit the directory to your module repository, or gitignore it. Dropwhale doesn't care. -3. Reanme docker-compose.override.yml.dist to docker-compose.override.yml (no .dist). -4. Edit docker-compose.override.yml, replace your_module_name with your module machine name. -5. Edit the docker-compose-override.yml file, adding the +3. Copy `.docker/docker-compose.override.yml.dist` to `.docker/docker-compose.override.yml` (no `.dist`). +4. Edit `.docker/docker-compose.override.yml`, replace `your_module_name` with your module machine name. +5. Edit the `.docker/docker-compose-override.yml` file, adding the installation directory of your module, and adding your module name to the MODULE_ENABLE environment variable. -6. cd to the root of your module repository. Execute .docker/start.sh +6. cd to the root of your module repository. Execute `.docker/start.sh` +7. To stop your containers execute `.docker/stop.sh` -If you need to rebuild Drupal at any time, execute .docker/build.sh +## Readymade scripts +Repository has some readymade scripts to help you to manage your local environment. + +1. If you need to rebuild Drupal at any time, execute +`.docker/build.sh` + +2. To get a command line in a CLI container, execute +`.docker/bash.sh` + +3. Kill and delete the containers (but keep Docker images), execute +`.docker/delete.sh` +This is a faster way to get a clean environment compared to `nuke.sh` + +4. To run Drupal Console in the CLI container, execute +`.docker/drupal.sh` + +5. To run Drush in the CLI container, execute +`.docker/drush.sh` + +6. To kill **all** containers, delete **all** containers and images, execute +`.docker/nuke.sh` +**WARNING:** This leaves your entire system squeaky clean, but also deletes all docker resources, not just Dropwhale containers. + +7. To run PHPUnit in the cli container, execute +`.docker/run-tests.sh` ## License From 4faf11c9efe8061386c158f081ad42c7e48beee1 Mon Sep 17 00:00:00 2001 From: Perttu Ehn Date: Tue, 16 Aug 2016 11:18:48 +0300 Subject: [PATCH 2/4] Revert "README.md improvements; add descriptions of all available scripts." This reverts commit 14a719c8e88adf98bf6d40c49a652f2a1a4336cb. --- README.md | 37 ++++++------------------------------- 1 file changed, 6 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index ab41d0b..e208447 100644 --- a/README.md +++ b/README.md @@ -11,41 +11,16 @@ need to argue with xdebug or get Drush installed. It's all built in! ## Use -1. Download Dropwhale and copy the `.docker` directory to the root of your module repository. +1. Download Dropwhale and copy the .docker directory to the root of your module repository. 2. You can choose to commit the directory to your module repository, or gitignore it. Dropwhale doesn't care. -3. Copy `.docker/docker-compose.override.yml.dist` to `.docker/docker-compose.override.yml` (no `.dist`). -4. Edit `.docker/docker-compose.override.yml`, replace `your_module_name` with your module machine name. -5. Edit the `.docker/docker-compose-override.yml` file, adding the +3. Reanme docker-compose.override.yml.dist to docker-compose.override.yml (no .dist). +4. Edit docker-compose.override.yml, replace your_module_name with your module machine name. +5. Edit the docker-compose-override.yml file, adding the installation directory of your module, and adding your module name to the MODULE_ENABLE environment variable. -6. cd to the root of your module repository. Execute `.docker/start.sh` -7. To stop your containers execute `.docker/stop.sh` +6. cd to the root of your module repository. Execute .docker/start.sh -## Readymade scripts -Repository has some readymade scripts to help you to manage your local environment. - -1. If you need to rebuild Drupal at any time, execute -`.docker/build.sh` - -2. To get a command line in a CLI container, execute -`.docker/bash.sh` - -3. Kill and delete the containers (but keep Docker images), execute -`.docker/delete.sh` -This is a faster way to get a clean environment compared to `nuke.sh` - -4. To run Drupal Console in the CLI container, execute -`.docker/drupal.sh` - -5. To run Drush in the CLI container, execute -`.docker/drush.sh` - -6. To kill **all** containers, delete **all** containers and images, execute -`.docker/nuke.sh` -**WARNING:** This leaves your entire system squeaky clean, but also deletes all docker resources, not just Dropwhale containers. - -7. To run PHPUnit in the cli container, execute -`.docker/run-tests.sh` +If you need to rebuild Drupal at any time, execute .docker/build.sh ## License From 882baaa654ec9e8baf5bc75bfeebf1e727314c2b Mon Sep 17 00:00:00 2001 From: Perttu Ehn Date: Tue, 16 Aug 2016 11:22:08 +0300 Subject: [PATCH 3/4] README.md improvements; add descriptions of all available scripts. --- README.md | 42 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e208447..5f4036b 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,46 @@ need to argue with xdebug or get Drush installed. It's all built in! ## Use -1. Download Dropwhale and copy the .docker directory to the root of your module repository. +1. Download Dropwhale and copy the `.docker` directory to the root of your module repository. 2. You can choose to commit the directory to your module repository, or gitignore it. Dropwhale doesn't care. -3. Reanme docker-compose.override.yml.dist to docker-compose.override.yml (no .dist). -4. Edit docker-compose.override.yml, replace your_module_name with your module machine name. -5. Edit the docker-compose-override.yml file, adding the +3. Copy `.docker/docker-compose.override.yml.dist` to `.docker/docker-compose.override.yml` (no `.dist`). +4. Edit `.docker/docker-compose.override.yml`, replace `your_module_name` with your module machine name. +5. Edit the `.docker/docker-compose-override.yml` file, adding the installation directory of your module, and adding your module name to the MODULE_ENABLE environment variable. -6. cd to the root of your module repository. Execute .docker/start.sh +6. cd to the root of your module repository. Execute `.docker/start.sh` +7. To stop your containers execute `.docker/stop.sh` -If you need to rebuild Drupal at any time, execute .docker/build.sh +## Readymade scripts +Repository has some readymade scripts to help you to manage your local environment. + +1. If you need to rebuild Drupal at any time, execute +`.docker/build.sh` + +2. To get a command line in a CLI container, execute +`.docker/bash.sh` + +3. Kill and delete the containers (but keep Docker images), execute +`.docker/delete.sh` + +4. To run Drupal Console in the CLI container, execute +`.docker/drupal.sh` + +5. To run Drush in the CLI container, execute +`.docker/drush.sh` + +6. To kill **all** containers, delete **all** containers and images, execute +`.docker/nuke.sh` +**WARNING:** This leaves your entire system squeaky clean, but also deletes all +docker resources, not just Dropwhale containers. + +7. To run PHPUnit in the cli container, execute +`.docker/run-tests.sh` +**WARNING:** This leaves your entire system squeaky clean, but also deletes all +_other_ docker resources, not just Dropwhale containers. + +8. To run PHPUnit in the cli container, execute +`.docker/run-tests.sh` ## License From e254e645492d4f838f02bf51e9cf15beb930153b Mon Sep 17 00:00:00 2001 From: Perttu Ehn Date: Fri, 26 Aug 2016 18:22:54 +0300 Subject: [PATCH 4/4] #12 Improve README.md with info how to execute PHPUnit tests for a single module. --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5f4036b..498d49c 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,9 @@ docker resources, not just Dropwhale containers. 7. To run PHPUnit in the cli container, execute `.docker/run-tests.sh` -**WARNING:** This leaves your entire system squeaky clean, but also deletes all -_other_ docker resources, not just Dropwhale containers. -8. To run PHPUnit in the cli container, execute -`.docker/run-tests.sh` +8. To run PHPUnit tests for a single module "mymodule" in the cli container, execute +`.docker/run-tests.sh --module mymodule` ## License