From 2da6e4bac2a57c2c3a3928583ee73b758bb68f06 Mon Sep 17 00:00:00 2001
From: Suguru Hirahara <acioustick@noreply.codeberg.org>
Date: Wed, 5 Mar 2025 13:27:30 +0900
Subject: [PATCH] Update validate_config.yml for migration: add instruction to
 check docs/maintenance-upgrading-services.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---
 .../tasks/validate_config.yml                 | 36 +++++++++----------
 1 file changed, 18 insertions(+), 18 deletions(-)

diff --git a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml
index 5558a6117..514925f93 100644
--- a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml
+++ b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml
@@ -84,7 +84,7 @@
 
       Please rename all `matrix_postgres`-prefixed variables (`matrix_postgres_*` -> `postgres_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'matrix_postgres_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'matrix_postgres_.*') | list | items2dict"
@@ -97,7 +97,7 @@
 
       Please rename all `matrix_mailer`-prefixed variables (`matrix_mailer_*` -> `exim_relay_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'matrix_mailer_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'matrix_mailer_.*') | list | items2dict"
@@ -114,7 +114,7 @@
           The matrix-prometheus-node-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_prometheus_node_exporter_` -> `prometheus_node_exporter_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars | length > 0"
 
@@ -130,7 +130,7 @@
           The matrix-prometheus-postgres-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_prometheus_postgres_exporter_` -> `prometheus_postgres_exporter_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars | length > 0"
 
@@ -146,7 +146,7 @@
           The matrix-backup-borg role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_backup_borg_` -> `backup_borg_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_backup_borg_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_backup_borg_migration_vars | length > 0"
 
@@ -162,7 +162,7 @@
           The matrix-grafana role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-grafana.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_grafana_` -> `grafana_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_grafana_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_grafana_migration_vars | length > 0"
 
@@ -178,7 +178,7 @@
           The matrix-ntfy role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-ntfy.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_ntfy_` -> `ntfy_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_ntfy_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_ntfy_migration_vars | length > 0"
 
@@ -194,7 +194,7 @@
           The matrix-redis role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-redis.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_redis_` -> `redis_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_redis_migration_vars | length > 0"
 
@@ -209,7 +209,7 @@
         msg: >-
           The Redis role that used to be part of this playbook has been superseded by https://github.com/mother-of-all-self-hosting/ansible-role-valkey.
           Please rename all variables (`redis_` -> `valkey_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_redis_migration_vars | length > 0"
 
@@ -224,7 +224,7 @@
         msg: >-
           The KeyDB role that used to be part of this playbook has been superseded by https://github.com/mother-of-all-self-hosting/ansible-role-valkey.
           Please rename all variables (`keydb_` -> `valkey_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_keydb_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_keydb_migration_vars | length > 0"
 
@@ -240,7 +240,7 @@
           The matrix-etherpad role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-etherpad.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_etherpad_` -> `etherpad_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_etherpad_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_etherpad_migration_vars | length > 0"
 
@@ -256,7 +256,7 @@
           The matrix-aux role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-aux.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_aux_` -> `aux_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_aux_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_aux_migration_vars | length > 0"
 
@@ -272,7 +272,7 @@
           The matrix-jitsi role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-jitsi.
           The new role is compatible with the old one, but uses different names for its variables.
           Please rename all variables (`matrix_jitsi_` -> `jitsi_`) on your configuration file (vars.yml).
-          After renaming them, please do not forget to fetch the Ansible role.
+          After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
           The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_jitsi_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_jitsi_migration_vars | length > 0"
 
@@ -438,7 +438,7 @@
 
       Please rename all `devture_postgres_backup_`-prefixed variables (`devture_postgres_backup_*` -> `postgres_backup_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_postgres_backup_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_postgres_backup_.*') | list | items2dict"
@@ -451,7 +451,7 @@
 
       Please rename all `devture_postgres_`-prefixed variables (`devture_postgres_*` -> `postgres_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_postgres_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_postgres_.*') | list | items2dict"
@@ -464,7 +464,7 @@
 
       Please rename all `devture_traefik_certs_dumper_`-prefixed variables (`devture_traefik_certs_dumper_*` -> `traefik_certs_dumper_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_traefik_certs_dumper_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_traefik_certs_dumper_.*') | list | items2dict"
@@ -477,7 +477,7 @@
 
       Please rename all `devture_traefik_`-prefixed variables (`devture_traefik_*` -> `traefik_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_traefik_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_traefik_.*') | list | items2dict"
@@ -490,7 +490,7 @@
 
       Please rename all `devture_container_socket_proxy_`-prefixed variables (`devture_container_socket_proxy_*` -> `container_socket_proxy_*`) on your configuration file (vars.yml).
 
-      After renaming them, please do not forget to fetch the Ansible role.
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
 
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_container_socket_proxy_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_container_socket_proxy_.*') | list | items2dict"