From 4011eaf258ad41e5c91720c4a2a21d82137ea184 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Mon, 8 Jan 2024 19:30:20 +0200 Subject: [PATCH] Rename variables having an incorrect prefix (matrix_bot_cactus_ -> matrix_cactus_) Looks like these variables were originally named this way in https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2089 --- .../custom/matrix-cactus-comments/defaults/main.yml | 4 ++-- .../matrix-cactus-comments/tasks/validate_config.yml | 12 +++++++++++- .../systemd/matrix-cactus-comments.service.j2 | 4 ++-- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/roles/custom/matrix-cactus-comments/defaults/main.yml b/roles/custom/matrix-cactus-comments/defaults/main.yml index d25152228..20f3f9261 100644 --- a/roles/custom/matrix-cactus-comments/defaults/main.yml +++ b/roles/custom/matrix-cactus-comments/defaults/main.yml @@ -52,10 +52,10 @@ matrix_cactus_comments_client_nginx_path: "/cactus-comments/" matrix_cactus_comments_client_endpoint: "/cactus-comments/" # List of systemd services that matrix-cactus-comments.service depends on -matrix_bot_cactus_comments_systemd_required_services_list: ['docker.service'] +matrix_cactus_comments_systemd_required_services_list: ['docker.service'] # List of systemd services that matrix-cactus-comments.service wants -matrix_bot_cactus_comments_systemd_wanted_services_list: [] +matrix_cactus_comments_systemd_wanted_services_list: [] # A list of extra arguments to pass to the container matrix_cactus_comments_container_extra_arguments: [] diff --git a/roles/custom/matrix-cactus-comments/tasks/validate_config.yml b/roles/custom/matrix-cactus-comments/tasks/validate_config.yml index 094a203df..b88d4ba89 100644 --- a/roles/custom/matrix-cactus-comments/tasks/validate_config.yml +++ b/roles/custom/matrix-cactus-comments/tasks/validate_config.yml @@ -1,6 +1,6 @@ --- -- name: Fail if required settings not defined +- name: Fail if required matrix-cactus-comments settings not defined ansible.builtin.fail: msg: >- You need to define a required configuration setting (`{{ item }}`). @@ -8,3 +8,13 @@ with_items: - "matrix_cactus_comments_as_token" - "matrix_cactus_comments_hs_token" + +- name: (Deprecation) Catch and report renamed matrix-cactus-comments 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_bot_cactus_comments_systemd_required_services_list', 'new': 'matrix_cactus_comments_systemd_required_services_list'} + - {'old': 'matrix_bot_cactus_comments_systemd_wanted_services_list', 'new': 'matrix_cactus_comments_systemd_wanted_services_list'} diff --git a/roles/custom/matrix-cactus-comments/templates/systemd/matrix-cactus-comments.service.j2 b/roles/custom/matrix-cactus-comments/templates/systemd/matrix-cactus-comments.service.j2 index b35e5e6c3..184cdc4dc 100644 --- a/roles/custom/matrix-cactus-comments/templates/systemd/matrix-cactus-comments.service.j2 +++ b/roles/custom/matrix-cactus-comments/templates/systemd/matrix-cactus-comments.service.j2 @@ -1,11 +1,11 @@ #jinja2: lstrip_blocks: "True" [Unit] Description=Cactus Comments -{% for service in matrix_bot_cactus_comments_systemd_required_services_list %} +{% for service in matrix_cactus_comments_systemd_required_services_list %} Requires={{ service }} After={{ service }} {% endfor %} -{% for service in matrix_bot_cactus_comments_systemd_wanted_services_list %} +{% for service in matrix_cactus_comments_systemd_wanted_services_list %} Wants={{ service }} {% endfor %} DefaultDependencies=no