Initial work on using externally defined roles

roles/custom/matrix-base/defaults/main.yml

@@ -255,12 +255,6 @@ matrix_well_known_matrix_support_configuration: "{{ matrix_well_known_matrix_sup
 # The Docker network that all services would be put into
 matrix_docker_network: "matrix"
 
-# Controls whether we'll preserve the vars.yml file on the Matrix server.
-# If you have a differently organized inventory, you may wish to disable this feature,
-# or to repoint `matrix_vars_yml_snapshotting_src` to the file you'd like to preserve.
-matrix_vars_yml_snapshotting_enabled: true
-matrix_vars_yml_snapshotting_src: "{{ inventory_dir }}/host_vars/{{ inventory_hostname }}/vars.yml"
-
 # Controls whether a `/.well-known/matrix/server` file is generated and used at all.
 #
 # If you wish to rely on DNS SRV records only, you can disable this.
@@ -284,11 +278,6 @@ matrix_docker_installation_enabled: true
 # Possible values are "docker-ce" (default) and "docker.io" (Debian).
 matrix_docker_package_name: docker-ce
 
-# Controls whether the current playbook's commit hash is saved in `git_hash.yml` on the target
-# Set this to false if GIT is not installed on the local system (the system where the ansible command is run on)
-# to suppress the warning message.
-matrix_playbook_commit_hash_preservation_enabled: true
-
 # Variables to Control which parts of our roles run.
 run_postgres_import: true
 run_postgres_upgrade: true

roles/custom/matrix-base/tasks/setup_matrix_base.yml

@@ -10,61 +10,6 @@
   with_items:
     - "{{ matrix_base_data_path }}"
 
-- name: Preserve vars.yml on the server for easily restoring if it gets lost later on
-  ansible.builtin.copy:
-    src: "{{ matrix_vars_yml_snapshotting_src }}"
-    dest: "{{ matrix_base_data_path }}/vars.yml"
-    owner: "{{ matrix_user_username }}"
-    group: "{{ matrix_user_groupname }}"
-    mode: '0660'
-  when: "matrix_vars_yml_snapshotting_enabled | bool"
-
-- name: Save current git-repo status on the target to aid with restoring in case of problems
-  when: "matrix_playbook_commit_hash_preservation_enabled|bool"
-  block:
-    - name: Get local git hash  # noqa command-instead-of-module
-      delegate_to: 127.0.0.1
-      become: false
-      register: git_describe
-      changed_when: false
-      ansible.builtin.shell:
-        git describe
-            --always
-            --tags
-            --dirty
-            --long
-            --all
-
-    - ansible.builtin.set_fact:
-        git_hash: "{{ git_describe.stdout }}"
-
-    - name: Git hash
-      ansible.builtin.debug:
-        msg: "Git hash: {{ git_hash }}"
-
-    - name: Save git_hash.yml on target
-      ansible.builtin.copy:
-        content: "{{ git_hash }}"
-        dest: "{{ matrix_base_data_path }}/git_hash.yml"
-        owner: "{{ matrix_user_username }}"
-        group: "{{ matrix_user_groupname }}"
-        mode: '0660'
-
-  rescue:
-    - name: GIT not found error
-      ansible.builtin.debug:
-        msg: >-
-          Couldn't find GIT on the local machine. Continuing without saving the GIT hash.
-          You can disable saving the GIT hash by setting 'matrix_playbook_commit_hash_preservation_enabled: false' in vars.yml
-      when: "git_describe.stderr.find('git: not found') != -1"
-
-    - name: Get GIT hash error
-      ansible.builtin.fail:
-        msg: >-
-          Error when trying to get the GIT hash. Please consult the error message above.
-          You can disable saving the GIT hash by setting 'matrix_playbook_commit_hash_preservation_enabled: false' in vars.yml
-      when: "git_describe.stderr.find('git: not found') == -1"
-
 - name: Ensure Matrix network is created in Docker
   community.docker.docker_network:
     name: "{{ matrix_docker_network }}"

roles/custom/matrix-bridge-hookshot/defaults/main.yml

@@ -129,8 +129,8 @@ matrix_hookshot_generic_user_id_prefix: '_webhooks_'
 
 
 matrix_hookshot_feeds_enabled: true
-matrix_hookshot_feeds_pollIntervalSeconds: 600  # no-qa var-naming
-matrix_hookshot_feeds_pollTimeoutSeconds: 10  # no-qa var-naming
+matrix_hookshot_feeds_pollIntervalSeconds: 600  # noqa var-naming
+matrix_hookshot_feeds_pollTimeoutSeconds: 10  # noqa var-naming
 
 
 # There is no need to edit ports. use matrix_hookshot_container_http_host_bind_ports below to expose ports instead.

roles/custom/matrix_playbook_migration/tasks/main.yml

@@ -0,0 +1,5 @@
+---
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  tags:
+    - setup-all

roles/custom/matrix_playbook_migration/tasks/validate_config.yml

@@ -0,0 +1,12 @@
+---
+
+- name: (Deprecation) Catch and report renamed Matrix playbook settings
+  ansible.builtin.fail:
+    msg: >-
+      Your configuration contains a variable, which now has a different name.
+      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
+  when: "item.old in vars"
+  with_items:
+    - {'old': 'matrix_vars_yml_snapshotting_enabled', 'new': 'devture_playbook_state_preserver_vars_preservation_enabled'}
+    - {'old': 'matrix_vars_yml_snapshotting_src', 'new': 'devture_playbook_state_preserver_vars_preservation_src'}
+    - {'old': 'matrix_playbook_commit_hash_preservation_enabled', 'new': 'devture_playbook_state_preserver_commit_hash_preservation_enabled'}