Lint role BLD-5736

Author: rockdreamer

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.yml]
+indent_style = space
+indent_size = 2

.github/workflows/common_ccdc_status_checks.yml

@@ -1,3 +1,4 @@
+---
 # This status check is updated on all repositories by the moan.py script
 # in the github-repository-management repository.
 # Changes in this file will be overwritten periodically.

.github/workflows/lint-ansible-role.yml

@@ -0,0 +1,30 @@
+---
+name: Lint
+
+on: [pull_request]
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+          architecture: x64
+
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Install linters
+        run: pip install ansible ansible-lint yamllint
+
+      - name: Run ansible-lint
+        run: "ansible-lint ."
+
+      - name: Run yamllint
+        run: "yamllint ."

.yamllint.yml

@@ -0,0 +1,61 @@
+# -*- mode: yaml -*-
+# vim:ts=2:sw=2:ai:si:syntax=yaml
+#
+# yamllint configuration directives
+# Project Homepage: https://github.com/adrienverge/yamllint
+#
+# Overriding rules in files:
+# http://yamllint.readthedocs.io/en/latest/disable_with_comments.html
+---
+extends: default
+
+# Rules documentation: http://yamllint.readthedocs.io/en/latest/rules.html
+rules:
+  braces:
+    # Defaults
+    # min-spaces-inside: 0
+    # max-spaces-inside: 0
+
+    # Keeping 0 min-spaces to not error on empty collection definitions
+    min-spaces-inside: 0
+    # Allowing one space inside braces to improve code readability
+    max-spaces-inside: 1
+
+  brackets:
+    # Defaults
+    # min-spaces-inside: 0
+    # max-spaces-inside: 0
+
+    # Keeping 0 min-spaces to not error on empty collection definitions
+    min-spaces-inside: 0
+    # Allowing one space inside braces to improve code readability
+    max-spaces-inside: 1
+
+  comments:
+    # Defaults
+    # level: warning
+    # require-starting-space: true
+
+    # Disabling to allow for code comment blocks and #!/usr/bin/ansible-playbook
+    require-starting-space: false
+    min-spaces-from-content: 1
+
+  indentation:
+    # Defaults
+    # spaces: consistent
+    # indent-sequences: true
+    # check-multi-line-strings: false
+
+    # Requiring 2 space indentation
+    spaces: 2
+    # Requiring consistent indentation within a file, either indented or not
+    indent-sequences: consistent
+
+  # Disabling due to copious amounts of long lines in the code which would
+  # require a code style change to resolve
+  line-length:
+    # Defaults
+    max: 160
+
+  # Disabling due to become: true being used pervasively in roles
+  truthy: disable

meta/main.yml

@@ -1,17 +1,17 @@
 ---
-    dependencies: []
-    
-    galaxy_info:
-      role_name: cpp_build_machine_macos_configuration
-      author: rockdreamer
-      description: Configuration for CCDC macOS build machines.
-      company: The Cambridge Crystallographic Data Centre
-      license: "license (BSD, MIT)"
-      min_ansible_version: 2.9
-      platforms:
-        - name: Darwin
-          versions:
-            - all
-      galaxy_tags:
-        - system
-    
+dependencies: []
+
+galaxy_info:
+  role_name: cpp_build_machine_macos_configuration
+  namespace: ccdc
+  author: rockdreamer
+  description: Configuration for CCDC MacOS build machines.
+  company: The Cambridge Crystallographic Data Centre
+  license: "license (BSD, MIT)"
+  min_ansible_version: 2.9
+  platforms:
+    - name: MacOSX
+      versions:
+        - all
+  galaxy_tags:
+    - system

requirements.yml

@@ -1,3 +1,5 @@
 ---
-  - src: https://github.com/feffi/ansible-macos-standby.git
-    name: feffi.macos-standby
+- src: https://github.com/feffi/ansible-macos-standby.git
+  name: feffi.macos-standby
+- src: https://github.com/feffi/ansible-macos-defaults.git
+  name: feffi.macos-defaults

tasks/defaults-for-build-machine-speed.yml

@@ -60,7 +60,7 @@
     - Restart Finder
 
 - name: show info in login screen
-  become: yes
+  become: true
   osx_defaults:
     domain: /Library/Preferences/com.apple.loginwindow
     key: AdminHostInfo

tasks/disable-autoupdates.yml

@@ -2,4 +2,4 @@
 - name: Disable automatic updates
   command: softwareupdate --schedule off
   changed_when: false
-  become: true
+  become: true

tasks/disable-spotlight.yml

@@ -1,20 +1,20 @@
 ---
-- name: Disable constant indexing by spotlight
+- name: Disable constant indexing by spotlight # noqa: no-changed-when
   command: mdutil -i off /
-  ignore_errors: true
+  ignore_errors: true # noqa: ignore-errors
   become: true
 
-- name: kill all spotlight indexers
+- name: kill all spotlight indexers # noqa: no-changed-when
   command: killall mds
-  ignore_errors: true
+  ignore_errors: true # noqa: ignore-errors
   become: true
 
-- name: rebuild spotlight index
+- name: rebuild spotlight index # noqa: no-changed-when
   command: mdutil -E
-  ignore_errors: true
+  ignore_errors: true # noqa: ignore-errors
   become: true
 
-- name: Disable constant indexing by spotlight
+- name: Disable constant indexing by spotlight # noqa: no-changed-when
   command: mdutil -i off /
-  ignore_errors: true
+  ignore_errors: true # noqa: ignore-errors
   become: true

tasks/never-sleep.yml

@@ -16,4 +16,3 @@
     standby_delay: false
     hibernate_mode: 0
     remove_sleepimage: true
-