Rename matrix_wechat_* variables to matrix_bridge_wechat_*

Part of adopting a uniform naming policy for bridge variables,
where the variable prefix matches the role directory name.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

roles/custom/matrix-bridge-wechat/tasks/install.yml

@@ -13,107 +13,107 @@
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
   with_items:
-    - {path: "{{ matrix_wechat_base_path }}", when: true}
-    - {path: "{{ matrix_wechat_config_path }}", when: true}
-    - {path: "{{ matrix_wechat_data_path }}", when: true}
-    - {path: "{{ matrix_wechat_container_src_files_path }}", when: "{{ matrix_wechat_container_image_self_build }}"}
-    - {path: "{{ matrix_wechat_agent_container_src_files_path }}", when: "{{ matrix_wechat_agent_container_image_self_build }}"}
+    - {path: "{{ matrix_bridge_wechat_base_path }}", when: true}
+    - {path: "{{ matrix_bridge_wechat_config_path }}", when: true}
+    - {path: "{{ matrix_bridge_wechat_data_path }}", when: true}
+    - {path: "{{ matrix_bridge_wechat_container_src_files_path }}", when: "{{ matrix_bridge_wechat_container_image_self_build }}"}
+    - {path: "{{ matrix_bridge_wechat_agent_container_src_files_path }}", when: "{{ matrix_bridge_wechat_agent_container_image_self_build }}"}
   when: item.when | bool
 
 - name: Ensure WeChat Bridge image is pulled
   community.docker.docker_image_pull:
-    name: "{{ matrix_wechat_container_image }}"
+    name: "{{ matrix_bridge_wechat_container_image }}"
     pull: always
-  when: not matrix_wechat_container_image_self_build
-  register: matrix_wechat_container_image_pull_result
+  when: not matrix_bridge_wechat_container_image_self_build
+  register: matrix_bridge_wechat_container_image_pull_result
   retries: "{{ devture_playbook_help_container_retries_count }}"
   delay: "{{ devture_playbook_help_container_retries_delay }}"
-  until: matrix_wechat_container_image_pull_result is not failed
+  until: matrix_bridge_wechat_container_image_pull_result is not failed
 
-- when: matrix_wechat_container_image_self_build | bool
+- when: matrix_bridge_wechat_container_image_self_build | bool
   block:
     - name: Ensure WeChat Bridge repository is present on self-build
       ansible.builtin.git:
-        repo: "{{ matrix_wechat_container_image_self_build_repo }}"
-        dest: "{{ matrix_wechat_container_src_files_path }}"
-        version: "{{ matrix_wechat_container_image_self_build_branch }}"
+        repo: "{{ matrix_bridge_wechat_container_image_self_build_repo }}"
+        dest: "{{ matrix_bridge_wechat_container_src_files_path }}"
+        version: "{{ matrix_bridge_wechat_container_image_self_build_branch }}"
         force: "yes"
       become: true
       become_user: "{{ matrix_user_name }}"
-      register: matrix_wechat_git_pull_results
+      register: matrix_bridge_wechat_git_pull_results
 
     - name: Ensure WeChat Bridge container image is built
       community.docker.docker_image_build:
-        name: "{{ matrix_wechat_container_image }}"
+        name: "{{ matrix_bridge_wechat_container_image }}"
         dockerfile: Dockerfile
-        path: "{{ matrix_wechat_container_src_files_path }}"
+        path: "{{ matrix_bridge_wechat_container_src_files_path }}"
         pull: true
-        rebuild: "{{ 'always' if matrix_wechat_git_pull_results.changed | bool else 'never' }}"
-      register: matrix_wechat_container_image_build_result
+        rebuild: "{{ 'always' if matrix_bridge_wechat_git_pull_results.changed | bool else 'never' }}"
+      register: matrix_bridge_wechat_container_image_build_result
 
 - name: Ensure WeChat Agent image is pulled
   community.docker.docker_image_pull:
-    name: "{{ matrix_wechat_agent_container_image }}"
+    name: "{{ matrix_bridge_wechat_agent_container_image }}"
     pull: always
-  when: not matrix_wechat_agent_container_image_self_build
-  register: matrix_wechat_agent_container_image_pull_result
+  when: not matrix_bridge_wechat_agent_container_image_self_build
+  register: matrix_bridge_wechat_agent_container_image_pull_result
   retries: "{{ devture_playbook_help_container_retries_count }}"
   delay: "{{ devture_playbook_help_container_retries_delay }}"
-  until: matrix_wechat_agent_container_image_pull_result is not failed
+  until: matrix_bridge_wechat_agent_container_image_pull_result is not failed
 
-- when: matrix_wechat_agent_container_image_self_build | bool
+- when: matrix_bridge_wechat_agent_container_image_self_build | bool
   block:
     - name: Ensure WeChat Agent repository is present on self-build
       ansible.builtin.git:
-        repo: "{{ matrix_wechat_agent_container_image_self_build_repo }}"
-        dest: "{{ matrix_wechat_agent_container_src_files_path }}"
-        version: "{{ matrix_wechat_agent_container_image_self_build_branch }}"
+        repo: "{{ matrix_bridge_wechat_agent_container_image_self_build_repo }}"
+        dest: "{{ matrix_bridge_wechat_agent_container_src_files_path }}"
+        version: "{{ matrix_bridge_wechat_agent_container_image_self_build_branch }}"
         force: "yes"
       become: true
       become_user: "{{ matrix_user_name }}"
-      register: matrix_wechat_agent_git_pull_results
+      register: matrix_bridge_wechat_agent_git_pull_results
 
     - name: Ensure WeChat Agent container image is built
       community.docker.docker_image_build:
-        name: "{{ matrix_wechat_agent_container_image }}"
+        name: "{{ matrix_bridge_wechat_agent_container_image }}"
         dockerfile: Dockerfile
-        path: "{{ matrix_wechat_agent_container_src_files_path }}"
+        path: "{{ matrix_bridge_wechat_agent_container_src_files_path }}"
         pull: true
-        rebuild: "{{ 'always' if matrix_wechat_agent_git_pull_results.changed | bool else 'never' }}"
-      register: matrix_wechat_agent_container_image_build_result
+        rebuild: "{{ 'always' if matrix_bridge_wechat_agent_git_pull_results.changed | bool else 'never' }}"
+      register: matrix_bridge_wechat_agent_container_image_build_result
 
 - name: Ensure WeChat configuration installed
   ansible.builtin.copy:
-    content: "{{ matrix_wechat_configuration | to_nice_yaml(indent=2, width=999999) }}"
-    dest: "{{ matrix_wechat_config_path }}/config.yaml"
+    content: "{{ matrix_bridge_wechat_configuration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_bridge_wechat_config_path }}/config.yaml"
     mode: '0644'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
-  register: matrix_wechat_config_result
+  register: matrix_bridge_wechat_config_result
 
 - name: Ensure WeChat registration.yaml installed
   ansible.builtin.copy:
-    content: "{{ matrix_wechat_registration | to_nice_yaml(indent=2, width=999999) }}"
-    dest: "{{ matrix_wechat_config_path }}/registration.yaml"
+    content: "{{ matrix_bridge_wechat_registration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_bridge_wechat_config_path }}/registration.yaml"
     mode: '0644'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
-  register: matrix_wechat_registration_result
+  register: matrix_bridge_wechat_registration_result
 
 - name: Ensure Wechat Agent configuration installed
   ansible.builtin.copy:
-    content: "{{ matrix_wechat_agent_configuration | to_nice_yaml(indent=2, width=999999) }}"
-    dest: "{{ matrix_wechat_config_path }}/agent-config.yaml"
+    content: "{{ matrix_bridge_wechat_agent_configuration | to_nice_yaml(indent=2, width=999999) }}"
+    dest: "{{ matrix_bridge_wechat_config_path }}/agent-config.yaml"
     mode: '0644'
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
-  register: matrix_wechat_agent_config_result
+  register: matrix_bridge_wechat_agent_config_result
 
 - name: Ensure matrix-wechat container network is created
-  when: matrix_wechat_container_network != 'host'
+  when: matrix_bridge_wechat_container_network != 'host'
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
-    name: "{{ matrix_wechat_container_network }}"
+    name: "{{ matrix_bridge_wechat_container_network }}"
     driver: bridge
     driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
 
@@ -122,26 +122,26 @@
     src: "{{ role_path }}/templates/systemd/matrix-wechat.service.j2"
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-wechat.service"
     mode: '0644'
-  register: matrix_wechat_systemd_service_result
+  register: matrix_bridge_wechat_systemd_service_result
 
 - name: Ensure matrix-wechat-agent.service installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/systemd/matrix-wechat-agent.service.j2"
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-wechat-agent.service"
     mode: '0644'
-  register: matrix_wechat_agent_systemd_service_result
+  register: matrix_bridge_wechat_agent_systemd_service_result
 
 - name: Determine whether WeChat Bridge needs a restart
   ansible.builtin.set_fact:
-    matrix_wechat_restart_necessary: >-
+    matrix_bridge_wechat_restart_necessary: >-
       {{
-        matrix_wechat_config_result.changed | default(false)
-        or matrix_wechat_registration_result.changed | default(false)
-        or matrix_wechat_agent_config_result.changed | default(false)
-        or matrix_wechat_systemd_service_result.changed | default(false)
-        or matrix_wechat_agent_systemd_service_result.changed | default(false)
-        or matrix_wechat_container_image_pull_result.changed | default(false)
-        or matrix_wechat_agent_container_image_pull_result.changed | default(false)
-        or matrix_wechat_container_image_build_result.changed | default(false)
-        or matrix_wechat_agent_container_image_build_result.changed | default(false)
+        matrix_bridge_wechat_config_result.changed | default(false)
+        or matrix_bridge_wechat_registration_result.changed | default(false)
+        or matrix_bridge_wechat_agent_config_result.changed | default(false)
+        or matrix_bridge_wechat_systemd_service_result.changed | default(false)
+        or matrix_bridge_wechat_agent_systemd_service_result.changed | default(false)
+        or matrix_bridge_wechat_container_image_pull_result.changed | default(false)
+        or matrix_bridge_wechat_agent_container_image_pull_result.changed | default(false)
+        or matrix_bridge_wechat_container_image_build_result.changed | default(false)
+        or matrix_bridge_wechat_agent_container_image_build_result.changed | default(false)
       }}

roles/custom/matrix-bridge-wechat/tasks/main.yml

@@ -10,15 +10,15 @@
     - install-all
     - install-wechat
   block:
-    - when: matrix_wechat_enabled | bool
+    - when: matrix_bridge_wechat_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
 
-    - when: matrix_wechat_enabled | bool
+    - when: matrix_bridge_wechat_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml"
 
 - tags:
     - setup-all
     - setup-wechat
   block:
-    - when: not matrix_wechat_enabled | bool
+    - when: not matrix_bridge_wechat_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml"

roles/custom/matrix-bridge-wechat/tasks/uninstall.yml

@@ -7,9 +7,9 @@
 - name: Check existence of matrix-wechat service
   ansible.builtin.stat:
     path: "/etc/systemd/system/matrix-wechat.service"
-  register: matrix_wechat_service_stat
+  register: matrix_bridge_wechat_service_stat
 
-- when: matrix_wechat_service_stat.stat.exists | bool
+- when: matrix_bridge_wechat_service_stat.stat.exists | bool
   block:
     - name: Ensure matrix-wechat is stopped
       ansible.builtin.service:
@@ -26,9 +26,9 @@
 - name: Check existence of matrix-wechat-agent service
   ansible.builtin.stat:
     path: "/etc/systemd/system/matrix-wechat-agent.service"
-  register: matrix_wechat_agent_service_stat
+  register: matrix_bridge_wechat_agent_service_stat
 
-- when: matrix_wechat_agent_service_stat.stat.exists | bool
+- when: matrix_bridge_wechat_agent_service_stat.stat.exists | bool
   block:
     - name: Ensure matrix-wechat-agent is stopped
       ansible.builtin.service:

roles/custom/matrix-bridge-wechat/tasks/validate_config.yml

@@ -10,12 +10,12 @@
       You need to define a required configuration setting (`{{ item.name }}`).
   when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
   with_items:
-    - {'name': 'matrix_wechat_appservice_token', when: true}
-    - {'name': 'matrix_wechat_homeserver_address', when: true}
-    - {'name': 'matrix_wechat_homeserver_token', when: true}
-    - {'name': 'matrix_wechat_database_hostname', when: "{{ matrix_wechat_database_engine == 'postgres' }}"}
-    - {'name': 'matrix_wechat_container_network', when: true}
-    - {'name': 'matrix_wechat_bridge_listen_secret', when: true}
+    - {'name': 'matrix_bridge_wechat_appservice_token', when: true}
+    - {'name': 'matrix_bridge_wechat_homeserver_address', when: true}
+    - {'name': 'matrix_bridge_wechat_homeserver_token', when: true}
+    - {'name': 'matrix_bridge_wechat_database_hostname', when: "{{ matrix_bridge_wechat_database_engine == 'postgres' }}"}
+    - {'name': 'matrix_bridge_wechat_container_network', when: true}
+    - {'name': 'matrix_bridge_wechat_bridge_listen_secret', when: true}
 
 - name: Fail if WeChat enabled on ARM64 (not supported by the wechat agent, even with self-building)
   when: matrix_architecture not in ['amd64']
@@ -28,7 +28,7 @@
       The variable `{{ item.old }}` is deprecated. Please use `{{ item.new }}` instead.
   when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
   with_items:
-    - {'old': 'matrix_wechat_container_image_name_prefix', 'new': 'matrix_wechat_container_image_registry_prefix'}
-    - {'old': 'matrix_wechat_agent_container_image_name_prefix', 'new': 'matrix_wechat_agent_container_image_registry_prefix'}
-    - {'old': 'matrix_wechat_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
-    - {'old': 'matrix_wechat_agent_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
+    - {'old': 'matrix_bridge_wechat_container_image_name_prefix', 'new': 'matrix_bridge_wechat_container_image_registry_prefix'}
+    - {'old': 'matrix_bridge_wechat_agent_container_image_name_prefix', 'new': 'matrix_bridge_wechat_agent_container_image_registry_prefix'}
+    - {'old': 'matrix_bridge_wechat_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}
+    - {'old': 'matrix_bridge_wechat_agent_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}