From d96c37776dcbd10e4d57534d900d8a0b8942fc24 Mon Sep 17 00:00:00 2001 From: Jeff Geerling Date: Sat, 11 Mar 2017 11:59:44 -0600 Subject: [PATCH] Bump default Drush make Core version to 8.2.6, fix build docs. --- docs/deployment/composer-dependency.md | 6 +++--- docs/deployment/composer-package.md | 2 +- docs/deployment/composer.md | 10 +++++----- docs/deployment/drush-make.md | 10 +++++----- docs/deployment/local-codebase.md | 12 ++++++------ example.drupal.make.yml | 4 ++-- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/deployment/composer-dependency.md b/docs/deployment/composer-dependency.md index 7209dcae7..8487fe1f3 100644 --- a/docs/deployment/composer-dependency.md +++ b/docs/deployment/composer-dependency.md @@ -12,7 +12,7 @@ composer require --dev geerlingguy/drupal-vm Add and configure the `config.yml` anywhere you like, in this example we place it in a `config/` directory. -_Note: This will be the directory where Drupal VM looks for other local configuration files as well. Such as `build_makefile`, `local.config.yml` and `Vagrantfile.local`._ +_Note: This will be the directory where Drupal VM looks for other local configuration files as well. Such as `drupal_build_makefile`, `local.config.yml` and `Vagrantfile.local`._ ``` ├── composer.json @@ -32,8 +32,8 @@ _Note: This will be the directory where Drupal VM looks for other local configur Change the [build strategy to use your `composer.json`](composer.md#using-composer-when-drupal-vm-is-a-composer-dependency-itself) file by setting: ```yaml -build_composer_project: false -build_composer: true +drupal_build_composer_project: false +drupal_build_composer: true drupal_composer_path: false drupal_composer_install_dir: "/var/www/drupalvm" drupal_core_path: "{{ drupal_composer_install_dir }}/docroot" diff --git a/docs/deployment/composer-package.md b/docs/deployment/composer-package.md index 816d56f31..382f37f65 100644 --- a/docs/deployment/composer-package.md +++ b/docs/deployment/composer-package.md @@ -2,7 +2,7 @@ Out of the box Drupal VM is configured to use `composer create-project` to build This is set up with the following variables in `config.yml`: - - Composer will build the project if `build_composer_project` is `true`, and `build_makefile` and `build_composer` are both `false`. + - Composer will build the project if `drupal_build_composer_project` is `true`, and `drupal_build_makefile` and `drupal_build_composer` are both `false`. - The Composer package is defined by `drupal_composer_project_package`. - Adjust the create-project CLI options in `drupal_composer_project_options` as well as add additional dependencies in `drupal_composer_dependencies`. - Ensure that the webroot configured in the Composer package matches the one set in `drupal_core_path`. The default is set to `web/`. diff --git a/docs/deployment/composer.md b/docs/deployment/composer.md index d64f2ecf1..6d04b94de 100644 --- a/docs/deployment/composer.md +++ b/docs/deployment/composer.md @@ -1,12 +1,12 @@ Drupal VM is configured to use `composer create-project` to build a Drupal 8 codebase by default but supports building Drupal from a custom `composer.json` file as well. 1. Copy `example.drupal.composer.json` to `drupal.composer.json` and modify it to your liking. -2. Use the Composer build system by setting `build_composer: true` in your `config.yml` (make sure `build_makefile` and `build_composer_project` are set to `false`). +2. Use the Composer build system by setting `drupal_build_composer: true` in your `config.yml` (make sure `drupal_build_makefile` and `build_composer_project` are set to `false`). 3. Configure `drupal_core_path` to point to the webroot directory: `drupal_core_path: {{ drupal_composer_install_dir }}/docroot` ```yaml -build_composer_project: false -build_composer: true +drupal_build_composer_project: false +drupal_build_composer: true drupal_core_path: "{{ drupal_composer_install_dir }}/docroot" ``` @@ -17,8 +17,8 @@ _The file set in `drupal_composer_path` (which defaults to `drupal.composer.json In the scenario where you have an existing `composer.json` in the root of your project, follow the usual steps for installing with a composer.json but instead of creating a `drupal.composer.json` file, disable the transfering of the file by setting `drupal_composer_path: false`, and change `drupal_composer_install_dir` to point to the the directory where it will be located. If `drupal_composer_path` is not truthy, Drupal VM assumes it already exists. ```yaml -build_composer_project: false -build_composer: true +drupal_build_composer_project: false +drupal_build_composer: true drupal_composer_path: false drupal_composer_install_dir: "/var/www/drupalvm" drupal_core_path: "{{ drupal_composer_install_dir }}/docroot" diff --git a/docs/deployment/drush-make.md b/docs/deployment/drush-make.md index f7fce8a9c..26b39b458 100644 --- a/docs/deployment/drush-make.md +++ b/docs/deployment/drush-make.md @@ -1,8 +1,8 @@ -If you want to build a Drupal site using a [Drush make file](http://www.drush.org/en/master/make/) instead of composer, set `build_composer_project: false`, `build_makefile: true` and either use the `example.drupal.make.yml` file as a base, or use your own Drush make file: just place it or symlink it into the root of the Drupal VM folder with the filename `drupal.make.yml`. You can also set a separate path to the makefile using the `drush_makefile_path` variable. +If you want to build a Drupal site using a [Drush make file](http://www.drush.org/en/master/make/) instead of composer, set `drupal_build_composer_project: false`, `drupal_build_makefile: true` and either use the `example.drupal.make.yml` file as a base, or use your own Drush make file: just place it or symlink it into the root of the Drupal VM folder with the filename `drupal.make.yml`. You can also set a separate path to the makefile using the `drush_makefile_path` variable. ```yaml -build_composer_project: false -build_makefile: true +drupal_build_composer_project: false +drupal_build_makefile: true ``` Have a look at the defaults in `default.config.yml` and tweak the settings as you'd like in your `config.yml`, then run `vagrant up` as in the Quick Start Guide. Within a few minutes, you should have your site running and available at the `drupal_domain` configured in `config.yml`, falling back to the default `http://drupalvm.dev` set in `default.config.yml`. @@ -10,7 +10,7 @@ Have a look at the defaults in `default.config.yml` and tweak the settings as yo With the default settings the Drupal site will be built on the VM inside `/var/www/drupalvm/drupal/web` but the `web/` subdirectory is only required for `composer` based projects and you can simplify this directory structure by setting `drupal_core_path` to `/var/www/drupalvm/drupal`. ```yaml -build_composer_project: false -build_makefile: true +drupal_build_composer_project: false +drupal_build_makefile: true drupal_core_path: "/var/www/drupalvm/drupal" ``` diff --git a/docs/deployment/local-codebase.md b/docs/deployment/local-codebase.md index 607da6152..1ad452458 100644 --- a/docs/deployment/local-codebase.md +++ b/docs/deployment/local-codebase.md @@ -15,17 +15,17 @@ _If you have Drupal VM installed within your codebase, you can also set the `loc ## Disable the Composer project build and site install -Set all the `build_*` variables and `install_site` to `false`: +Set all the `drupal_build_*` variables and `install_site` to `false`: ```yaml -build_makefile: false -build_composer: false -build_composer_project: false +drupal_build_makefile: false +drupal_build_composer: false +drupal_build_composer_project: false ... -install_site: false +drupal_install_site: false ``` -If you aren't copying back a database, and want to have Drupal VM run `drush si` for your Drupal site, you can leave `install_site` set to `true` and it will run a site install on your Drupal codebase using the `drupal_*` config variables. +If you aren't copying back a database, and want to have Drupal VM run `drush si` for your Drupal site, you can leave `drupal_install_site` set to `true` and it will run a site install on your Drupal codebase using the `drupal_*` config variables. ## Update `drupal_core_path` diff --git a/example.drupal.make.yml b/example.drupal.make.yml index 0fba08d49..04b70e99a 100644 --- a/example.drupal.make.yml +++ b/example.drupal.make.yml @@ -11,12 +11,12 @@ projects: # Core. drupal: - version: "8.1.8" + version: "8.2.6" # Use this if you need a working git repository of Drupal core instead of # the latest stable. # type: "core" # download: - # # Drupal core branch (e.g. "6.x", "7.x", "8.0.x"). + # # Drupal core branch (e.g. "6.x", "7.x", "8.2.x", "8.3.x"). # branch: "8.1.x" # working-copy: true