From 1a6c78ba7ca2f237911f4583d9a115fae256aefd Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Tue, 19 Mar 2024 14:43:23 +0100 Subject: [PATCH 01/11] Initial draft for the README.md improvements --- README.md | 49 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 37 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 18e37d5..b366319 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,62 @@ -# ddev-core-dev +# ddev-drupal-core-dev -This is a DDEV addon for doing Drupal core development. +* [What is ddev-drupal-core-dev](#what-is-ddev-drupal-core-dev) +* [Initial Setup](#initial-setup) +* [Install Drupal](#install-drupal) +* [PHP Unit](#install-drupal) +* [Nighwatch](#install-drupal) + +## What is `ddev-drupal-core-dev` +This is a DDEV-addon for doing Drupal Core development. + + +## Initial Setup We're in #ddev-for-core-dev on [Drupal Slack](https://www.drupal.org/community/contributor-guide/reference-information/talk/tools/slack) (but please try and keep work and feature requests in Issues where it's visible to all 🙏) ``` git clone https://git.drupalcode.org/project/drupal.git drupal cd drupal -ddev config --project-type=drupal10 +ddev config --project-type=drupal10 --omit-containers=db ddev start ddev corepack enable ddev get justafish/ddev-drupal-core-dev ddev restart ddev composer install +```` +Because `ddev-drupal-core-dev` is using SQLite the database container could be omitted on `ddev config --project-type=drupal10 --omit-containers=db`. + -# See included commands +## Install Drupal + +To get an overview of the list of available tasks: + +``` ddev drupal list +```` + +Next install a demo site, which is not intended for production: -# Install drupal +```` ddev drupal install +```` +> :warning: There is no need to `composer require drush/drush` to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. -# Run PHPUnit tests -ddev phpunit core/modules/sdc +In case you need to drop your database tables because you are for example working in the context of the Drupal installer you can simply manually delete the SQLite database file located in `sites/default/files/.sqlite`. + + +## PHPUnit -# Run Nightwatch tests (currently only runs on Chrome) -ddev nightwatch --tag core +``` +ddev phpunit core/modules/sdc ``` -## Nightwatch Examples + +## Nightwatch You can watch Nightwatch running in real time at https://drupal.ddev.site:7900 for Chrome and https://drupal.ddev.site:7901 for Firefox. The password is -"secret". YMMV using Firefox as core tests don't currently run on it. +"secret". YMMV using Firefox as core tests don't currently run on it.(currently only runs on Chrome) Only core tests ``` @@ -71,4 +96,4 @@ ddev nightwatch --tag a11y:default --defaultTheme bartik a11y test for a custom admin theme ``` ddev nightwatch --tag a11y:admin --adminTheme seven -``` +``` \ No newline at end of file From bcc57ab359f71ca3cb4c96099b1f0e2ca09d60f3 Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Tue, 19 Mar 2024 14:45:41 +0100 Subject: [PATCH 02/11] add the missing ddev to ddev composer require --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b366319..826e8e7 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Next install a demo site, which is not intended for production: ```` ddev drupal install ```` -> :warning: There is no need to `composer require drush/drush` to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. +> :warning: There is no need to `ddev composer require drush/drush` to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. In case you need to drop your database tables because you are for example working in the context of the Drupal installer you can simply manually delete the SQLite database file located in `sites/default/files/.sqlite`. From 520f50c7d09617c662b90487d1d3dfaf4cfc5ba5 Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Wed, 27 Mar 2024 15:08:10 +0100 Subject: [PATCH 03/11] Fix the links in the TOC and add a link to the ddev repo in the introduction --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 826e8e7..52d68db 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # ddev-drupal-core-dev -* [What is ddev-drupal-core-dev](#what-is-ddev-drupal-core-dev) +* [What is ddev-drupal-core-dev?](#what-is-ddev-drupal-core-dev) * [Initial Setup](#initial-setup) * [Install Drupal](#install-drupal) -* [PHP Unit](#install-drupal) -* [Nighwatch](#install-drupal) +* [PHP Unit](#php-unit) +* [Nighwatch](#nightwatch) -## What is `ddev-drupal-core-dev` -This is a DDEV-addon for doing Drupal Core development. +## What is ddev-drupal-core-dev? +This is a [DDEV](https://github.com/ddev/ddev) add-on for doing Drupal Core development. ## Initial Setup From 1c66eee16a2ae426952d40238c41252d79a8841d Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Tue, 16 Apr 2024 21:27:52 +0200 Subject: [PATCH 04/11] update the flags for ddev config --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 52d68db..e6c90cf 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ We're in #ddev-for-core-dev on [Drupal Slack](https://www.drupal.org/community/c ``` git clone https://git.drupalcode.org/project/drupal.git drupal cd drupal -ddev config --project-type=drupal10 --omit-containers=db +ddev config --omit-containers=db --disable-settings-management ddev start ddev corepack enable ddev get justafish/ddev-drupal-core-dev From af8ad0bad2dd9668cd7210cdfe79c7c61fec82f9 Mon Sep 17 00:00:00 2001 From: Ralf Koller <1665422+rpkoller@users.noreply.github.com> Date: Sat, 27 Apr 2024 22:23:55 +0200 Subject: [PATCH 05/11] Rename PHP Unit to PHPUnit Co-authored-by: Randy Fay --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e6c90cf..c239569 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ * [What is ddev-drupal-core-dev?](#what-is-ddev-drupal-core-dev) * [Initial Setup](#initial-setup) * [Install Drupal](#install-drupal) -* [PHP Unit](#php-unit) +* [PHPUnit](#phpunit) * [Nighwatch](#nightwatch) ## What is ddev-drupal-core-dev? From 8da53e69a4e3f035b3a0388e8e7b4747bdd1a940 Mon Sep 17 00:00:00 2001 From: Ralf Koller <1665422+rpkoller@users.noreply.github.com> Date: Sat, 27 Apr 2024 22:27:17 +0200 Subject: [PATCH 06/11] More explicit warning NOT to composer require drush Co-authored-by: Randy Fay --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c239569..e2c3da6 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Next install a demo site, which is not intended for production: ```` ddev drupal install ```` -> :warning: There is no need to `ddev composer require drush/drush` to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. +> :warning: To avoid unstaged conflicts in git, **do not** `ddev composer require drush/drush`. A subset of that kind of functionality is available with `ddev drupal list`. In case you need to drop your database tables because you are for example working in the context of the Drupal installer you can simply manually delete the SQLite database file located in `sites/default/files/.sqlite`. From c28ca98c822ad20382a4533dc3123dde65000a16 Mon Sep 17 00:00:00 2001 From: Ralf Koller <1665422+rpkoller@users.noreply.github.com> Date: Sat, 27 Apr 2024 22:29:53 +0200 Subject: [PATCH 07/11] Some improvement to the drop db sentence Co-authored-by: Randy Fay --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e2c3da6..5d271bf 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ ddev drupal install ```` > :warning: To avoid unstaged conflicts in git, **do not** `ddev composer require drush/drush`. A subset of that kind of functionality is available with `ddev drupal list`. -In case you need to drop your database tables because you are for example working in the context of the Drupal installer you can simply manually delete the SQLite database file located in `sites/default/files/.sqlite`. +To drop your database tables, for example if you're working in the context of the Drupal installer, manually delete the SQLite database file located in `sites/default/files/.sqlite`. ## PHPUnit From 1af78973a27d09d74a9915657b768d503f887255 Mon Sep 17 00:00:00 2001 From: Ralf Koller <1665422+rpkoller@users.noreply.github.com> Date: Sat, 27 Apr 2024 22:30:39 +0200 Subject: [PATCH 08/11] Update the info for nightwatch Co-authored-by: Randy Fay --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d271bf..010fefb 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ ddev phpunit core/modules/sdc You can watch Nightwatch running in real time at https://drupal.ddev.site:7900 for Chrome and https://drupal.ddev.site:7901 for Firefox. The password is -"secret". YMMV using Firefox as core tests don't currently run on it.(currently only runs on Chrome) +"secret". (Core tests using Firefox are not yet mature.) Only core tests ``` From afbf74b0c8e26c4f2484f05cfc4bbd38d7d82b89 Mon Sep 17 00:00:00 2001 From: Ralf Koller <1665422+rpkoller@users.noreply.github.com> Date: Sat, 27 Apr 2024 23:02:50 +0200 Subject: [PATCH 09/11] change the sdc example to workspaces sdc went stable and the given sdc directory contains only a single yaml file. no tests no nothing anymore. Co-authored-by: Randy Fay --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 010fefb..3fdf1cb 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ To drop your database tables, for example if you're working in the context of th ## PHPUnit ``` -ddev phpunit core/modules/sdc +ddev phpunit core/modules/workspaces ``` From c26b7e87e98a52d6131d0aac1f53e864f343e4d5 Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Sat, 27 Apr 2024 23:09:58 +0200 Subject: [PATCH 10/11] Move the explanation about the database containe omission is moved into the quickstart as a comment --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3fdf1cb..65401d4 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ We're in #ddev-for-core-dev on [Drupal Slack](https://www.drupal.org/community/c ``` git clone https://git.drupalcode.org/project/drupal.git drupal cd drupal +# Because `ddev-drupal-core-dev` is using SQLite the database +# container is omitted by the `--omit-containers=db` flag ddev config --omit-containers=db --disable-settings-management ddev start ddev corepack enable @@ -24,8 +26,6 @@ ddev get justafish/ddev-drupal-core-dev ddev restart ddev composer install ```` -Because `ddev-drupal-core-dev` is using SQLite the database container could be omitted on `ddev config --project-type=drupal10 --omit-containers=db`. - ## Install Drupal From 3eec7748f8a819dc5ae0de645c669ad921633b66 Mon Sep 17 00:00:00 2001 From: Ralf Koller Date: Wed, 1 May 2024 15:40:38 +0200 Subject: [PATCH 11/11] change the instructions for dropping the db from manually deletion to drupal uninstall --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65401d4..51e2487 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ ddev drupal install ```` > :warning: To avoid unstaged conflicts in git, **do not** `ddev composer require drush/drush`. A subset of that kind of functionality is available with `ddev drupal list`. -To drop your database tables, for example if you're working in the context of the Drupal installer, manually delete the SQLite database file located in `sites/default/files/.sqlite`. +To drop your database tables, for example if you're working in the context of the Drupal installer, simply run `ddev drupal uninstall`. That deletes the `settings.php` file and the `/sites/default/files` folder including the SQLite database file. ## PHPUnit