Accommodate deploy hook vars formatted as lists of includes (#815)

* Use lists for hooks.
* Move deploy hook variables to defaults/.
* Add loop_control/loop_var to hooks.

CHANGELOG.md

@@ -1,4 +1,5 @@
 ### HEAD
+* Accommodate deploy hook vars formatted as lists of includes ([#815](https://github.com/roots/trellis/pull/815))
 * Check Ansible version before Ansible validates task attributes ([#797](https://github.com/roots/trellis/pull/797))
 * Add additional Nginx sites configurations support ([#793](https://github.com/roots/trellis/pull/793))
 * Change `remote-user` role to `connection` role: tests host key, user ([#745](https://github.com/roots/trellis/pull/745))

deploy.yml

@@ -16,10 +16,6 @@
   remote_user: "{{ web_user }}"
 
   vars:
-    deploy_build_before: "{{ playbook_dir }}/deploy-hooks/build-before.yml"
-    deploy_build_after: "{{ playbook_dir }}/roles/deploy/hooks/build-after.yml"
-    deploy_finalize_before: "{{ playbook_dir }}/roles/deploy/hooks/finalize-before.yml"
-    deploy_finalize_after: "{{ playbook_dir }}/roles/deploy/hooks/finalize-after.yml"
     project: "{{ wordpress_sites[site] }}"
     project_root: "{{ www_root }}/{{ site }}"
     wordpress_env_defaults:

roles/deploy/defaults/main.yml

@@ -44,3 +44,19 @@ project_environment:
 # The project_current_path is the symlink used for the latest or active deployment
 # - default is 'current'
 project_current_path: "{{ project.current_path | default('current') }}"
+
+
+# Deploy hooks
+# For list of hooks and explanation, see https://roots.io/trellis/docs/deploys/#hooks
+deploy_build_before:
+  - "{{ playbook_dir }}/deploy-hooks/build-before.yml"
+
+deploy_build_after:
+  - "{{ playbook_dir }}/roles/deploy/hooks/build-after.yml"
+  # - "{{ playbook_dir }}/deploy-hooks/sites/{{ site }}-build-after.yml"
+
+deploy_finalize_before:
+  - "{{ playbook_dir }}/roles/deploy/hooks/finalize-before.yml"
+
+deploy_finalize_after:
+  - "{{ playbook_dir }}/roles/deploy/hooks/finalize-after.yml"

roles/deploy/tasks/build.yml

@@ -1,5 +1,8 @@
 ---
-- include: "{{ deploy_build_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_build_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-build-before
 
 - name: Copy project templates
@@ -20,5 +23,8 @@
   with_items: "{{ project_folder_paths.results }}"
   when: item.stat.exists
 
-- include: "{{ deploy_build_after | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_build_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-build-after

roles/deploy/tasks/finalize.yml

@@ -1,5 +1,8 @@
 ---
-- include: "{{ deploy_finalize_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_finalize_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-finalize-before
 
 - name: Finalize the deploy
@@ -9,7 +12,10 @@
     release: "{{ deploy_helper.new_release }}"
     state: finalize
 
-- include: "{{ deploy_finalize_after | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_finalize_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-finalize-after
 
 - debug:

roles/deploy/tasks/initialize.yml

@@ -1,5 +1,8 @@
 ---
-- include: "{{ deploy_initialize_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_initialize_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-initialize-before
 
 - name: Initialize
@@ -8,5 +11,8 @@
     path: "{{ project_root }}"
     state: present
 
-- include: "{{ deploy_initialize_after | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_initialize_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-initialize-after

roles/deploy/tasks/main.yml

@@ -1,11 +1,19 @@
 ---
-- include: "{{ deploy_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-before
+
 - include: initialize.yml
 - include: update.yml
 - include: prepare.yml
 - include: build.yml
 - include: share.yml
 - include: finalize.yml
-- include: "{{ deploy_after | default('../hooks/example.yml') }}"
+
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-after

roles/deploy/tasks/prepare.yml

@@ -1,5 +1,8 @@
 ---
-- include: "{{ deploy_prepare_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_prepare_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-prepare-before
 
 - name: write unfinished file
@@ -35,5 +38,8 @@
     chdir: "{{ project_source_path }}"
   when: project.repo_subtree_path is defined
 
-- include: "{{ deploy_prepare_after | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_prepare_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-prepare-after

roles/deploy/tasks/share.yml

@@ -1,5 +1,8 @@
 ---
-- include: "{{ deploy_share_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_share_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-share-before
 
 - name: Ensure shared sources are present -- directories
@@ -45,5 +48,8 @@
     state: link
   with_items: "{{ project_shared_children }}"
 
-- include: "{{ deploy_share_after | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_share_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-share-after

roles/deploy/tasks/update.yml

@@ -1,5 +1,8 @@
 ---
-- include: "{{ deploy_update_before | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_update_before | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-update-before
 
 - name: Add known_hosts
@@ -48,5 +51,8 @@
       > https://roots.io/trellis/docs/ssh-keys/#cloning-remote-repo-using-ssh-agent-forwarding
   when: git_clone | failed
 
-- include: "{{ deploy_update_after | default('../hooks/example.yml') }}"
+- include: "{{ include_path }}"
+  with_items: "{{ deploy_update_after | default([]) }}"
+  loop_control:
+    loop_var: include_path
   tags: deploy-update-after