style: rename tasks

defaults/main.yml

@@ -1,11 +1,11 @@
 ---
 # See available releases: https://gitlab.com/gitlab-org/gitlab-runner/-/releases
-# Install GitLab Runner using the official GitLab repositories
+## Install Gitlab Runner using the Gitlab repository
 gitlab_runner_package_version: ''
 gitlab_runner_repository_mirror_url: 'https://packages.gitlab.com/runner/gitlab-runner'
 gitlab_runner_repository_gpgkey_url: '{{ gitlab_runner_repository_mirror_url }}/gpgkey'
 
-# Install GitLab Runner manually on Windows
+## Install Gitlab Runner using a binary file (Windows)
 gitlab_runner_binary_version: '16.11.1'
 gitlab_runner_binary_name: 'gitlab-runner-{{ _gitlab_runner_os }}-{{ _gitlab_runner_architecture }}'
 gitlab_runner_binary_download_url: 'https://gitlab-runner-downloads.s3.amazonaws.com/v{{ gitlab_runner_binary_version }}/binaries'

tasks/install-Debian.yml

@@ -1,8 +1,8 @@
 ---
-- name: 'Configure APT repository and install Gitlab Runner package'
+- name: 'Debian | Configure the repository and install the GitLab Runner package'
   become: true
   block:
-    - name: 'Ensure dependencies are installed'
+    - name: 'Debian | Ensure dependencies are installed'
       ansible.builtin.apt:
         name:
           - 'apt-transport-https'
@@ -11,21 +11,21 @@
         state: 'present'
       when: not ansible_check_mode
 
-    - name: 'Add Gitlab Runner APT key'
+    - name: 'Debian | Add the Gitlab Runner repository GPG key'
       ansible.builtin.apt_key:
         url: '{{ gitlab_runner_repository_gpgkey_url }}'
         keyring: '{{ _gitlab_runner_local_gpgkey_path }}'
         state: 'present'
 
-    - name: 'Add Gitlab Runner APT repository'
+    - name: 'Debian | Add the Gitlab Runner repository'
       ansible.builtin.template:
         src: 'gitlab-runner.list.j2'
         dest: '/etc/apt/sources.list.d/gitlab-runner.list'
         owner: 'root'
         group: 'root'
         mode: 0644
 
-    - name: 'Install Gitlab Runner package'
+    - name: 'Debian | Install the Gitlab Runner package'
       ansible.builtin.apt:
         name: "gitlab-runner{{ ('=' + gitlab_runner_package_version) if (gitlab_runner_package_version | length) else '' }}"
         allow_downgrade: true

tasks/install-RedHat.yml

@@ -1,21 +1,21 @@
 ---
-- name: 'Configure YUM/DNF repository and install Gitlab Runner package'
+- name: 'RedHat | Configure the repository and install the GitLab Runner package'
   become: true
   block:
-    - name: 'Ensure dependencies are installed'
+    - name: 'RedHat | Ensure dependencies are installed'
       ansible.builtin.package:
         name: 'yum-utils'
         state: 'present'
 
-    - name: 'Add Gitlab Runner DNF/YUM repository'
+    - name: 'RedHat | Add the Gitlab Runner repository'
       ansible.builtin.template:
         src: 'gitlab-runner.repo.j2'
         dest: '/etc/yum.repos.d/gitlab-runner.repo'
         owner: 'root'
         group: 'root'
         mode: 0644
 
-    - name: 'Install Gitlab Runner package'
+    - name: 'RedHat | Install the Gitlab Runner package'
       ansible.builtin.yum:
         name: "gitlab-runner{{ ('-' + gitlab_runner_package_version) if (gitlab_runner_package_version | length) else '' }}"
         allow_downgrade: true

tasks/install-Windows.yml

@@ -1,57 +1,57 @@
 ---
-- name: 'Create Gitlab Runner directory'
+- name: 'Windows | Create the Gitlab Runner directory'
   ansible.windows.win_file:
     path: '{{ gitlab_runner_binary_install_path }}'
     state: 'directory'
 
-- name: 'Check if Gitlab Runner is installed'
+- name: 'Windows | Check if Gitlab Runner is installed'
   ansible.windows.win_stat:
     path: '{{ gitlab_runner_binary_install_path }}\gitlab-runner.exe'
   register: __gitlab_runner_is_installed
 
-- name: 'Check current Gitlab Runner version'
+- name: 'Windows | Check the current Gitlab Runner version'
   ansible.windows.win_command:
     cmd: '"{{ gitlab_runner_binary_install_path }}\gitlab-runner.exe" --version'
   failed_when: false
   changed_when: false
   register: __gitlab_runner_version_check
 
-- name: 'Download and install Gitlab Runner'
+- name: 'Windows | Download and install Gitlab Runner'
   when:
     - not __gitlab_runner_is_installed.stat.exists or
       (__gitlab_runner_version_check.stdout_lines | length and
       gitlab_runner_binary_version not in __gitlab_runner_version_check.stdout_lines[0].split()[1])
   block:
-    - name: 'Download Gitlab Runner binary to local folder'
+    - name: 'Windows | Download the Gitlab Runner binary to a local folder'
       ansible.builtin.get_url:
         url: '{{ gitlab_runner_binary_download_url }}/{{ gitlab_runner_binary_name }}.exe'
         dest: '/tmp/{{ gitlab_runner_binary_name }}-{{ gitlab_runner_binary_version }}.exe'
         mode: 0644
       delegate_to: localhost
       check_mode: false
 
-    - name: 'Ensure Gitlab Runner is stopped before binary version update'
+    - name: 'Windows | Ensure the Gitlab Runner service is stopped before version update'
       ansible.windows.win_service:
         name: 'gitlab-runner'
         state: 'stopped'
       when:
         - __gitlab_runner_is_installed.stat.exists and
           gitlab_runner_binary_version not in __gitlab_runner_version_check.stdout_lines[0].split()[1]
 
-    - name: 'Copy Gitlab Runner binary into place'
+    - name: 'Windows | Copy the Gitlab Runner binary into a place'
       ansible.windows.win_copy:
         src: '/tmp/{{ gitlab_runner_binary_name }}-{{ gitlab_runner_binary_version }}.exe'
         dest: '{{ gitlab_runner_binary_install_path }}\gitlab-runner.exe'
       when: not ansible_check_mode
 
-    - name: 'Install Gitlab Runner as service'
+    - name: 'Windows | Ensure that the Gitlab Runner is installed as a service'
       ansible.windows.win_command:
         cmd: '"{{ gitlab_runner_binary_install_path }}\gitlab-runner.exe" install'
       args:
         chdir: '{{ gitlab_runner_binary_install_path }}'
       when: not __gitlab_runner_is_installed.stat.exists
 
-- name: 'Ensure Gitlab Runner is running and enabled at boot'
+- name: 'Windows | Ensure the Gitlab Runner service is running and enabled at boot'
   ansible.windows.win_service:
     name: 'gitlab-runner'
     start_mode: 'auto'

tasks/main.yml

@@ -1,5 +1,5 @@
 ---
-- name: 'Include OS-specific Gitlab Runner variables'
+- name: 'Include the Gitlab Runner OS-specific variables'
   ansible.builtin.include_vars: '{{ ansible_os_family }}.yml'
 
 - name: 'Include tasks to install Gitlab Runner'