Merge pull request sap-linuxlab#594 from berndfinger/issue-593

collection: Rearrange the comments in all .ansible-lint files

.ansible-lint

@@ -21,12 +21,16 @@ exclude_paths:
   #- roles/sap_swpm
   - roles/sap_vm_preconfigure
   - tests/
-
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
   - experimental
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_anydb_install_oracle/.ansible-lint

@@ -1,7 +1,16 @@
 ---
+exclude_paths:
+  - tests/
 enable_list:
   - yaml
 skip_list:
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_general_preconfigure/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_ha_install_hana_hsr/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_ha_pacemaker_cluster/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_hana_install/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_hana_preconfigure/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_hostagent/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_hypervisor_node_preconfigure/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_install_media_detect/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_maintain_etc_hosts/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_netweaver_preconfigure/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_storage_setup/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_swpm/.ansible-lint

@@ -4,7 +4,13 @@ exclude_paths:
 enable_list:
   - yaml
 skip_list:
-  - meta-runtime[unsupported-version] # We don't want to enforce new Ansible versions for Galaxy
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]

roles/sap_vm_preconfigure/.ansible-lint

@@ -1,7 +1,16 @@
 ---
+exclude_paths:
+  - tests/
 enable_list:
   - yaml
 skip_list:
-  - ignore-errors # We use ignore_errors for all the assert tasks, which should be acceptable
-  - schema # We want to allow single digit version numbers in a role's meta/main.yml file. This is allowed as per https://galaxy.ansible.com/docs/contributing/creating_role.html and https://galaxy.ansible.com/api/v1/platforms/?page=6.
-  - name[template] # Allow templating inside name. During dev and qa, it should be possible to identify cases where it doesn't work
+  # We don't want to enforce new Ansible versions for Galaxy:
+  - meta-runtime[unsupported-version]
+  # We do not want to use checks which are marked as experimental:
+  - experimental
+  # We use ignore_errors for all the assert tasks, which should be acceptable:
+  - ignore-errors
+  # We want to allow single digit version numbers in a role's meta/main.yml file:
+  - schema
+  # Allow templating inside name because it creates more detailed output:
+  - name[template]