Feature branching pr 1.x

docs/roles/_init.md

@@ -35,12 +35,16 @@ drupal:
         - minute: "*/{{ 10 | random(start=1) }}"
           job: cron
       feature_branch: false # whether or not this build is a feature branch that should sync assets from another environment
-      # For syncing database and files on a feature branch initial build
-      mysql_sync: # see sync/database_sync for docs
-        databases: []
-      files_sync: # see sync/files_sync for docs
-        cleanup: true
-        directories: []
+      # For syncing database and files on a feature branch initial build - include all variables if used
+      mysql_sync: {} # see sync/database_sync for docs
+      #  mysqldump_params: "{{ _mysqldump_params }}"
+      #  cleanup: true
+      #  archival_method: gzip
+      #  databases: []
+      files_sync: {} # see sync/files_sync for docs
+      #  unique_workspace: false
+      #  cleanup: true
+      #  directories: []
 mautic:
   image_path: "media/images"
   force_install: false

docs/roles/composer.md

@@ -14,7 +14,7 @@ composer:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -24,6 +24,7 @@ composer:
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
   templates: []
+
 ```
 
 <!--ENDROLEVARS-->

docs/roles/config_generate.md

@@ -11,7 +11,7 @@ config_generate:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'

docs/roles/config_generate/config_generate-drupal8.md

@@ -4,4 +4,12 @@ Generates settings.php file for Drupal 8.
 <!--ENDTOC-->
 
 <!--ROLEVARS-->
+## Default variables
+```yaml
+config_generate_drupal:
+  # If you need to specify an exact file name for a template file to use for a build, you can do it here.
+  drupal_settings_file_name: settings.php
+  drush_settings_file_name: drush.yml
+```
+
 <!--ENDROLEVARS-->

docs/roles/npm.md

@@ -18,7 +18,7 @@ npm:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -28,6 +28,7 @@ npm:
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
   templates: []
+
 ```
 
 <!--ENDROLEVARS-->

roles/_init/README.md

@@ -35,12 +35,16 @@ drupal:
         - minute: "*/{{ 10 | random(start=1) }}"
           job: cron
       feature_branch: false # whether or not this build is a feature branch that should sync assets from another environment
-      # For syncing database and files on a feature branch initial build
-      mysql_sync: # see sync/database_sync for docs
-        databases: []
-      files_sync: # see sync/files_sync for docs
-        cleanup: true
-        directories: []
+      # For syncing database and files on a feature branch initial build - include all variables if used
+      mysql_sync: {} # see sync/database_sync for docs
+      #  mysqldump_params: "{{ _mysqldump_params }}"
+      #  cleanup: true
+      #  archival_method: gzip
+      #  databases: []
+      files_sync: {} # see sync/files_sync for docs
+      #  unique_workspace: false
+      #  cleanup: true
+      #  directories: []
 mautic:
   image_path: "media/images"
   force_install: false

roles/_init/defaults/main.yml

@@ -26,12 +26,16 @@ drupal:
         - minute: "*/{{ 10 | random(start=1) }}"
           job: cron
       feature_branch: false # whether or not this build is a feature branch that should sync assets from another environment
-      # For syncing database and files on a feature branch initial build
-      mysql_sync: # see sync/database_sync for docs
-        databases: []
-      files_sync: # see sync/files_sync for docs
-        cleanup: true
-        directories: []
+      # For syncing database and files on a feature branch initial build - include all variables if used
+      mysql_sync: {} # see sync/database_sync for docs
+      #  mysqldump_params: "{{ _mysqldump_params }}"
+      #  cleanup: true
+      #  archival_method: gzip
+      #  databases: []
+      files_sync: {} # see sync/files_sync for docs
+      #  unique_workspace: false
+      #  cleanup: true
+      #  directories: []
 mautic:
   image_path: "media/images"
   force_install: false

roles/composer/README.md

@@ -14,7 +14,7 @@ composer:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -24,6 +24,7 @@ composer:
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
   templates: []
+
 ```
 
 <!--ENDROLEVARS-->

roles/composer/defaults/main.yml

@@ -7,7 +7,7 @@ composer:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -16,4 +16,4 @@ composer:
   # Specify any additional templates to generate, with src (template) and dest (file).
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
-  templates: []
+  templates: []

roles/config_generate/README.md

@@ -11,7 +11,7 @@ config_generate:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'

roles/config_generate/config_generate-drupal8/README.md

@@ -4,4 +4,12 @@ Generates settings.php file for Drupal 8.
 <!--ENDTOC-->
 
 <!--ROLEVARS-->
+## Default variables
+```yaml
+config_generate_drupal:
+  # If you need to specify an exact file name for a template file to use for a build, you can do it here.
+  drupal_settings_file_name: settings.php
+  drush_settings_file_name: drush.yml
+```
+
 <!--ENDROLEVARS-->

roles/config_generate/config_generate-drupal8/defaults/main.yml

@@ -0,0 +1,4 @@
+config_generate_drupal:
+  # If you need to specify an exact file name for a template file to use for a build, you can do it here.
+  drupal_settings_file_name: settings.php
+  drush_settings_file_name: drush.yml

roles/config_generate/config_generate-drupal8/tasks/drush.yml

@@ -4,6 +4,7 @@
     src: '{{ item }}'
     dest: "{{ deploy_path }}/{{ webroot }}/sites/{{ site.folder }}/drush.yml"
   with_first_found:
-    - "{{ playbook_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.drush.yml.j2"
-    - "{{ _ce_deploy_build_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.drush.yml"
+    - "{{ playbook_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.{{ config_generate_drupal.drush_settings_file_name }}.j2"
+    - "{{ _ce_deploy_build_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.{{ config_generate_drupal.drush_settings_file_name }}"
+    - "{{ _ce_deploy_build_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ config_generate_drupal.drush_settings_file_name }}"
     - "drush.yml.j2"

roles/config_generate/config_generate-drupal8/tasks/settings.yml

@@ -23,6 +23,7 @@
     src: "{{ item }}"
     dest: "{{ deploy_path }}/{{ webroot }}/sites/{{ site.folder }}/settings.php"
   with_first_found:
-    - "{{ playbook_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.settings.php.j2"
-    - "{{ _ce_deploy_build_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.settings.php"
+    - "{{ playbook_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.{{ config_generate_drupal.drupal_settings_file_name }}.j2"
+    - "{{ _ce_deploy_build_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ build_type }}.{{ config_generate_drupal.drupal_settings_file_name }}"
+    - "{{ _ce_deploy_build_dir }}/{{ webroot }}/sites/{{ site.folder }}/{{ config_generate_drupal.drupal_settings_file_name }}"
     - "settings.php.j2"

roles/config_generate/defaults/main.yml

@@ -3,7 +3,7 @@ config_generate:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'

roles/live_symlink/defaults/main.yml

@@ -6,7 +6,7 @@ live_symlink:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -15,4 +15,4 @@ live_symlink:
   # Specify any additional templates to generate, with src (template) and dest (file).
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
-  templates: []
+  templates: []

roles/npm/README.md

@@ -18,7 +18,7 @@ npm:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -28,6 +28,7 @@ npm:
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
   templates: []
+
 ```
 
 <!--ENDROLEVARS-->

roles/npm/defaults/main.yml

@@ -11,7 +11,7 @@ npm:
   # Specify any additional symlink to create, with src (target) and dest (link).
   # src: can be either absolute or relative to the dest (eg. '/var/my_data', '/home/deploy/simplesaml', '../../../myconfig')
   # dest: can only be relative to the root of your repository (eg. 'www/themes/myassets', 'var/cache')
-  # create: wether to create the target if it does not exists.
+  # create: whether to create the target if it does not exists.
   #  - src: '/home/{{ deploy_user }}//{{ project_name }}_{{ build_type }}/simplesaml'
   #    dest: 'vendor/simplesamlphp/simplesamlphp/config'
   #  - src: '/var/simplesaml/etc'
@@ -20,4 +20,4 @@ npm:
   # Specify any additional templates to generate, with src (template) and dest (file).
   # src: name of a template, in the "templates" dir relative to your playbook.
   # dest: can only be relative to the root of your repository (eg. 'www/config.php', 'var/mysettings.php')
-  templates: []
+  templates: []