Merge branch 'main' into feature/recipes-support

README.md

@@ -9,15 +9,15 @@ Aljibe sits on top of DDEV and adds some containers, configuration and commands
 
 ## Included tools
 
-  - Behat: BDD and Acceptance testig
-  - BackstopJS: Visual regression testing
-  - Unlighthouse: Audit all website quality
-  - Pa11y: Accesibility checks
-  - MkDocs: Documentation wiki
-  - And more...
-
+- Behat: BDD and Acceptance testig
+- BackstopJS: Visual regression testing
+- Unlighthouse: Audit all website quality
+- Pa11y: Accesibility checks
+- MkDocs: Documentation wiki
+- And more...
 
 ## Requirements
+
 - [DDEV](https://ddev.readthedocs.io/en/stable/) 1.23.1 or higher
 - [Docker](https://www.docker.com/) 24 or higher
 
@@ -26,71 +26,101 @@ Aljibe sits on top of DDEV and adds some containers, configuration and commands
 Create a folder for your new project (e.g. `mkdir my-new-project`)
 Configure a basic ddev project:
 
-    ddev config --auto
+```sh
+ddev config --auto
+```
 
 Install the Aljibe addon. This will install all the dependant addons too:
 
-    ddev get metadrop/ddev-aljibe
+For DDEV v1.23.5 or above run:
+
+```sh
+ddev add-on get metadrop/ddev-aljibe
+```
+
+For earlier versions of DDEV run:
+
+```sh
+ddev get metadrop/ddev-aljibe
+```
 
 Launch Aljibe Assistant. This will guide you throught the basic Drupal site instalation process:
 
-    ddev aljibe-assistant
+```sh
+ddev aljibe-assistant
+```
 
 You are ready! you will have a new Drupal project based on Aljibe ready for development!
 
 ## Migrate legacy projects to DDEV Aljibe
 
 To transform a legacy project to Ddev Aljibe, the following steps must be followed, always taking into account the particularities of each project:
 
-1. Clone the project without install it and remove all docker related files 
-2. Run basic ddev-config:
+1. Clone the project without install it and remove all docker related files
+1. Run basic ddev-config:
+
+    ```sh
+    ddev config --auto
+    ```
 
-        ddev config --auto
-
-4. Install Aljibe:
+1. Install Aljibe:
 
-        ddev get metadrop/ddev-aljibe
-4. Run again ddev config, but this time go throught the assistant to set project type to Drupal, docroot folder, etc...
-
-        ddev config
-5. Edit .ddev/config.yml to fine tune the environment.
-6. Edit .ddev/aljibe.yml to set deault site name (the folder inside sites) and all themes to be transpiled
-7. update .gitignore to look like [this](https://github.com/Metadrop/ddev-aljibe/blob/main/aljibe-kickstart/.gitignore).
+    For DDEV v1.23.5 or above run:
+
+    ```sh
+    ddev add-on get metadrop/ddev-aljibe
+    ```
+
+    For earlier versions of DDEV run:
+
+    ```sh
+    ddev get metadrop/ddev-aljibe
+    ```
+
+1. Run again ddev config, but this time go throught the assistant to set project type to Drupal, docroot folder, etc...
+
+    ```sh
+    ddev config
+    ```
+
+1. Edit .ddev/config.yml to fine tune the environment.
+1. Edit .ddev/aljibe.yml to set deault site name (the folder inside sites) and all themes to be transpiled
+1. update .gitignore to look like [this](https://github.com/Metadrop/ddev-aljibe/blob/main/aljibe-kickstart/.gitignore).
 
 If you come from a [boilerplate](https://github.com/Metadrop/drupal-boilerplate) project:
 
 - Remove from settings.local.php database, trusted host patterns and others that can conflict with settings.ddev.php.
 - Adapt the drush alias to the new url.
-- Review tests folder structure as in aljibe, all tests (behat.yml included) are inside tests folder and replace http://apache or http://nginx by http://web.
+- Review tests folder structure as in aljibe, all tests (behat.yml included) are inside tests folder and replace <http://apache> or <http://nginx> by <http://web>.
 - Config also the nodejs_version in .ddev/config.yml with the same as the old project. Old version on .env file, variable **“NODE_TAG”**
 - Adapt grumphp changing EXEC_GRUMPHP_COMMAND on grumphp.yml to “ddev exec”
 - Launch ddev setup:
-    - If monosite: `ddev setup`
-    - If multisite:`ddev setup —all` or `ddev setup --sites=site1`
-
+  - If monosite: `ddev setup`
+  - If multisite:`ddev setup —all` or `ddev setup --sites=site1`
 
 ## Advanced Configuration
 
 The `aljibe.yml` file allows you to customize various aspects of the Aljibe setup. Below are the available options and how to use them:
 
-#### `default_site`
+### `default_site`
+
 This option sets the default site name to be processed. It is used when no specific site name is provided.
 
 ```yaml
 default_site: self
 ```
 
+### `theme_paths`
 
-#### `theme_paths`
 This section allows you to define paths to custom themes that need to be processed. Each theme should be listed with a unique key.
 
 ```yaml
 theme_paths:
   custom_theme: /var/www/html/web/themes/custom/custom_theme
 ```
 
+### `hooks`
 
-#### `hooks`
 Hooks are commands that can be executed at different stages of the setup process. They are defined as lists of commands under various hook points.
 
 - `pre_setup`: Commands to run before the setup process.
@@ -122,11 +152,13 @@ hooks:
 ```
 
 Available variables for site_install hooks are:
+
 - DRUPAL_PROFILE: The profile used to install the site.
 - SITE_PATH: The path to the site to be installed relative to web/sites
 - SITE_ALIAS: The drush alias of the site to be installed, without the @.
 
 Available variables for setup hooks are:
+
 - NO_THEMES: If the setup command was called with the --no-themes flag
 - NO_INSTALL: If the setup command was called with the --no-install flag
 - SITES: The sites to be installed
@@ -139,72 +171,101 @@ You can add any other configuration you need to the `aljibe.yml` file. This conf
 Example commands to obtain specific configurations:
 
 - To obtain all theme paths to be processed:
+
   ```sh
   ddev aljibe-config theme_path
   ```
 
 - To get the default site to be processed:
+
   ```sh
   ddev aljibe-config default_site
   ```
-    
+
 ## Usage
 
-#### Project setup in other machines 
+### Project setup in other machines
+
 Once the project has been created and uploaded to version control, anyone else working with it can clone it and with the following command you can have the project ready to work with.
 
-    ddev setup [--all] [--no-install] [--no-themes]
+```sh
+ddev setup [--all] [--no-install] [--no-themes]
+```
+
+### Unique site install (Multisite)
 
-#### Unique site install (Multisite)
 If you have a multisite instalation, you can install only one site by running:
 
-    ddev site-install <site_name>
+```sh
+ddev site-install <site_name>
+```
+
+### Create a secondary database
 
-#### Create a secondary database
 If you need to create a secondary database, you can run:
 
-    ddev create-database <db_name>
+```sh
+ddev create-database <db_name>
+```
+
+**NOTE**: This command will create a database accesible with the same user and password from the main one. If you want to persist this across multiples setups, you can add this command to te pre-setup hooks in .ddev/aljibe.yml file.
 
-**NOTE**: This command will create a database accesible with the same user and password from the main one. If you want to persist this across multiples setups, you can add this command to te pre-setup hooks in .ddev/aljibe.yml file. 
+### Launch behat tests
 
-#### Launch behat tests
 To launch local, or env tests, you can run:
 
-    ddev behat [local|pro|other_behat_folder] [suite]
+```sh
+ddev behat [local|pro|other_behat_folder] [suite]
+```
+
+### Process custom themes CSS
 
-#### Process custom themes CSS
 By default there is one theme defined in .ddev/aljibe.yml. You can add multiple themes. To process them, run:
 
-    ddev frontend production [theme_name]
+```sh
+ddev frontend production [theme_name]
+```
 
 where theme_name is the key defined in .ddev/aljibe.yml. You can run a watch command to process the CSS on the fly:
 
-    ddev frontend watch [theme_name]
+```sh
+ddev frontend watch [theme_name]
+```
+
+### Sync solr config
 
-#### Sync solr config
 If you use ddev-solr addon and need to sync the solr config from the server, you can run:
 
-    ddev solr-sync
+```sh
+ddev solr-sync
+```
+
+### Power off ddev
 
-#### Power off ddev
-    
-    ddev poweroff
+```sh
+ddev poweroff
+```
 
-# Troubleshooting
+## Troubleshooting
 
 ### https not working
 
-Follow ddev [install recomendations](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/#linux). 
+Follow ddev [install recomendations](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/#linux).
 It is needed to install mkcert and libnss3-tools, and then run:
 
-    mkcert -install
+```sh
+mkcert -install
+```
 
 ### Can't debug with NetBeans
-Until https://github.com/apache/netbeans/issues/7562 is solved you need to create a file named `xdebug.ini` at `.ddev/php` with the following content:
+
+Until <https://github.com/apache/netbeans/issues/7562> is solved you need to create a file named `xdebug.ini` at `.ddev/php` with the following content:
+
 ```
 [XDebug]
 xdebug.idekey = netbeans-xdebug
 ```
+
 NOTE: The `netbeans-xdebug` is the default Session ID value in the the Debugging tab in the PHP Netbeans' configuration dialog. If you have changed it do it in the `xdebug.ini` file as well.
 
 ### Xdebug profiler does not save the files
@@ -218,7 +279,6 @@ xdebug.start_with_request=yes
 # Set a ddev shared folder for the xprofile reports.
 xdebug.output_dir=/var/www/html/tmp/xprofile
 xdebug.profiler_output_name=trace.%c%p%r%u.out
-
 ```
 
 Review the php info (/admin/reports/status/php) page to review that the xdebug variables are setup properly after run ddev xdebug on, restart the project if necessary.

commands/host/aljibe-kickstart

@@ -1,19 +1,32 @@
 #!/bin/bash
 #ddev-generated
 ## Description: Copy kickstar files to the project root
-## Usage: aljibe-kickstart
+## Usage: aljibe-kickstart [options]
 ## Flags: [{"Name":"noinstall","Usage":"setup --noinstall"}]
 ## Example: ddev aljibe-kickstart
 
-
+DRUPAL_VERSION=d11
 AUTO_CONFIRM=false
 
+# Check if ${DDEV_APPROOT}/.ddev/kickstart/ exists, if not show a warning and exit
+if [ ! -d "${DDEV_APPROOT}/.ddev/kickstart" ]; then
+    echo "No kickstart files found in ${DDEV_APPROOT}/.ddev/kickstart/"
+    echo "If you want to kickstart your project again, reinstall aljibe add-on:"
+    echo "  - ddev add-on get metadrop/ddev-aljibe"
+    echo "And then launch aljibe-kickstart command again."
+    exit 1
+fi
+
 while (( "$#" )); do
   case "$1" in
     -y|--yes)
       AUTO_CONFIRM=true
       shift
       ;;
+    d10)
+      DRUPAL_VERSION=d10
+      shift
+      ;;
     *)
       shift
       ;;
@@ -28,10 +41,9 @@ else
 fi
 
 if [ "$CONFIRMATION" != "n" ]; then
-    cp -rTf ${DDEV_APPROOT}/.ddev/aljibe-kickstart ${DDEV_APPROOT}
-    rm -fR ${DDEV_APPROOT}/.ddev/aljibe-kickstart
-    ddev config --project-type=drupal --docroot=web
-    echo "Kickstart files have been copied."
+    cp -rTf ${DDEV_APPROOT}/.ddev/kickstart/common ${DDEV_APPROOT}
+    cp -rTf ${DDEV_APPROOT}/.ddev/kickstart/${DRUPAL_VERSION} ${DDEV_APPROOT}
+    echo "Kickstart files have been copied. Make sure yout .gitignore file ignores .ddev/kickstart directory."
 else
-    echo "Operation cancelled."
+    echo "Kickstart operation cancelled."
 fi

install.yaml

@@ -3,7 +3,7 @@ description:
 project_files:
  - commands
  - scripts
- - aljibe-kickstart
+ - kickstart
  - aljibe.yaml.example
  - site-profiles
  - config.aljibe.yaml

aljibe-kickstart/.gitignore → kickstart/common/.gitignore

@@ -66,7 +66,7 @@ nbproject/
 settings.ddev*.php
 
 ## Aljibe
-aljibe-kickstart
+.ddev/kickstart
 
 ## mkdocs
 docs/site