feat(semantic-release): update for this formula

* Updated using myii/ssf-formula#34

.rubocop.yml

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+# General overrides used across formulas in the org
+Metrics/LineLength:
+  # Increase from default of `80`
+  # Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
+  Max: 88
+
+# Any offenses that should be fixed, e.g. collected via. `rubocop --auto-gen-config`

.salt-lint

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+exclude_paths: []
+rules: {}
+skip_list:
+  # Using `salt-lint` for linting other files as well, such as Jinja macros/templates
+  - 205  # Use ".sls" as a Salt State file extension
+  # Skipping `207` and `208` because `210` is sufficient, at least for the time-being
+  # I.e. Allows 3-digit unquoted codes to still be used, such as `644` and `755`
+  - 207  # File modes should always be encapsulated in quotation marks
+  - 208  # File modes should always contain a leading zero
+tags: []
+verbosity: 1

.travis.yml

@@ -1,92 +1,116 @@
 # -*- coding: utf-8 -*-
 # vim: ft=yaml
 ---
-stages:
-  - test
-  - commitlint
-  - name: release
-    if: branch = master AND type != pull_request
+## Machine config
+os: 'linux'
+arch: 'amd64'
+dist: 'bionic'
+version: '~> 1.0'
 
-sudo: required
-cache: bundler
-language: ruby
-dist: xenial
+## Language and cache config
+language: 'ruby'
+cache: 'bundler'
 
+## Services config
 services:
   - docker
 
-# Make sure the instances listed below match up with
-# the `platforms` defined in `kitchen.yml`
-# NOTE: Please try to select up to six instances that add some meaningful
-#       testing of the formula's behaviour. If possible, try to refrain from
-#       the classical "chosing all the instances because I want to test on
-#       another/all distro/s" trap: it will just add time to the testing (see
-#       the discussion on #121).  As an example, the set chosen below covers
-#       the most used distros families, systemd and non-systemd and the latest
-#       three supported Saltstack versions with python2 and 3.
-#       As for `kitchen.yml`, that should still contain all of the platforms,
-#       to allow for comprehensive local testing
-#       Ref: https://github.com/saltstack-formulas/template-formula/issues/118
-#       Ref: https://github.com/saltstack-formulas/template-formula/issues/121
-env:
-  matrix:
-#    - INSTANCE: debian-debian-10-develop-py3
-    # - INSTANCE: ubuntu-ubuntu-1804-develop-py3
-    # - INSTANCE: centos-centos-7-develop-py3
-    # - INSTANCE: fedora30-fedora-30-develop-py3
-#    - INSTANCE: suse-opensuse-leap-15-develop-py3
-    - INSTANCE: amazonlinux-amazonlinux-2-develop-py2
-    # - INSTANCE: debian-debian-9-2019-2-py3
-#    - INSTANCE: ubuntu-ubuntu-1804-2019-2-py3
-    # - INSTANCE: centos-centos-7-2019-2-py3
-    # - INSTANCE: fedora30-fedora-30-2019-2-py3
-#    - INSTANCE: suse-opensuse-leap-15-2019-2-py3
-    - INSTANCE: amazonlinux-amazonlinux-2-2019-2-py2
-    # - INSTANCE: debian-debian-9-2018-3-py2
-    # - INSTANCE: ubuntu-ubuntu-1604-2018-3-py2
-    # - INSTANCE: centos-centos-7-2018-3-py2
-#    - INSTANCE: fedora29-fedora-29-2018-3-py2
-#    - INSTANCE: suse-opensuse-leap-15-2018-3-py2
-    - INSTANCE: amazonlinux-amazonlinux-2-2018-3-py2
-    # - INSTANCE: debian-debian-8-2017-7-py2
-    # - INSTANCE: ubuntu-ubuntu-1604-2017-7-py2
-    # - INSTANCE: centos-centos-6-2017-7-py2
-    # - INSTANCE: fedora29-fedora-29-2017-7-py2
-#    - INSTANCE: suse-opensuse-leap-15-2017-7-py2
-    - INSTANCE: amazonlinux-amazonlinux-2-2017-7-py2
-
+## Script to run for the test stage
 script:
-  - bin/kitchen verify ${INSTANCE}
+  - bin/kitchen verify "${INSTANCE}"
 
+## Stages and jobs matrix
+stages:
+  - test
+  - name: 'release'
+    if: 'branch = master AND type != pull_request'
 jobs:
   include:
-    # Define the commitlint stage
-    - stage: commitlint
-      language: node_js
-      node_js: lts/*
-      before_install: skip
+    ## Define the test stage that runs the linters (and testing matrix, if applicable)
+
+    # Run all of the linters in a single job
+    - language: 'node_js'
+      node_js: 'lts/*'
+      env: 'Lint'
+      name: 'Lint: salt-lint, yamllint, rubocop, shellcheck & commitlint'
+      before_install: 'skip'
       script:
-        - npm install @commitlint/config-conventional -D
-        - npm install @commitlint/travis-cli -D
+        # Install and run `salt-lint`
+        - pip install --user salt-lint
+        - git ls-files -- '*.sls' '*.jinja' '*.j2' '*.tmpl' '*.tst'
+                        | xargs salt-lint
+        # Install and run `yamllint`
+        # Need at least `v1.17.0` for the `yaml-files` setting
+        - pip install --user yamllint>=1.17.0
+        - yamllint -s .
+        # Install and run `rubocop`
+        - gem install rubocop
+        - rubocop -d
+        # Run `shellcheck` (already pre-installed in Travis)
+        - shellcheck --version
+        - git ls-files -- '*.sh' '*.bash' '*.ksh'
+                        | xargs shellcheck
+        # Install and run `commitlint`
+        - npm i -D @commitlint/config-conventional
+                   @commitlint/travis-cli
         - commitlint-travis
-    # Define the release stage that runs semantic-release
-    - stage: release
-      language: node_js
-      node_js: lts/*
-      before_install: skip
+
+    ## Define the rest of the matrix based on Kitchen testing
+    # Make sure the instances listed below match up with
+    # the `platforms` defined in `kitchen.yml`
+    - env: INSTANCE=debian-debian-10-master-py3
+    # - env: INSTANCE=ubuntu-ubuntu-1804-master-py3
+    # - env: INSTANCE=centos-centos-8-master-py3
+    # - env: INSTANCE=fedora-fedora-31-master-py3
+    # - env: INSTANCE=suse-opensuse-leap-151-master-py3
+    # - env: INSTANCE=amazon-amazonlinux-2-master-py2
+    # - env: INSTANCE=arch-arch-base-latest-master-py2
+    # - env: INSTANCE=debian-debian-10-2019-2-py3
+    # - env: INSTANCE=debian-debian-9-2019-2-py3
+    - env: INSTANCE=ubuntu-ubuntu-1804-2019-2-py3
+    # - env: INSTANCE=centos-centos-8-2019-2-py3
+    # - env: INSTANCE=fedora-fedora-31-2019-2-py3
+    - env: INSTANCE=suse-opensuse-leap-151-2019-2-py3
+    # - env: INSTANCE=centos-centos-7-2019-2-py2
+    - env: INSTANCE=amazon-amazonlinux-2-2019-2-py2
+    # - env: INSTANCE=arch-arch-base-latest-2019-2-py2
+    - env: INSTANCE=fedora-fedora-30-2018-3-py3
+    # - env: INSTANCE=debian-debian-9-2018-3-py2
+    # - env: INSTANCE=ubuntu-ubuntu-1604-2018-3-py2
+    - env: INSTANCE=centos-centos-7-2018-3-py2
+    # - env: INSTANCE=suse-opensuse-leap-151-2018-3-py2
+    # - env: INSTANCE=amazon-amazonlinux-2-2018-3-py2
+    # - env: INSTANCE=arch-arch-base-latest-2018-3-py2
+    # - env: INSTANCE=debian-debian-8-2017-7-py2
+    # - env: INSTANCE=ubuntu-ubuntu-1604-2017-7-py2
+    # - env: INSTANCE=centos-centos-6-2017-7-py2
+    # - env: INSTANCE=fedora-fedora-30-2017-7-py2
+    # - env: INSTANCE=suse-opensuse-leap-151-2017-7-py2
+    # - env: INSTANCE=amazon-amazonlinux-2-2017-7-py2
+    - env: INSTANCE=arch-arch-base-latest-2017-7-py2
+
+    ## Define the release stage that runs `semantic-release`
+    - stage: 'release'
+      language: 'node_js'
+      node_js: 'lts/*'
+      env: 'Release'
+      name: 'Run semantic-release inc. file updates to AUTHORS, CHANGELOG & FORMULA'
+      before_install: 'skip'
       script:
         # Update `AUTHORS.md`
         - export MAINTAINER_TOKEN=${GH_TOKEN}
         - go get github.com/myii/maintainer
         - maintainer contributor
 
         # Install all dependencies required for `semantic-release`
-        - npm install @semantic-release/changelog@3 -D
-        - npm install @semantic-release/exec@3 -D
-        - npm install @semantic-release/git@7 -D
+        - npm i -D @semantic-release/changelog@3
+                   @semantic-release/exec@3
+                   @semantic-release/git@7
       deploy:
-        provider: script
-        skip_cleanup: true
-        script:
-          # Run `semantic-release`
-          - npx semantic-release@15
+        provider: 'script'
+        # Opt-in to `dpl v2` to complete the Travis build config validation (beta)
+        # * https://docs.travis-ci.com/user/build-config-validation
+        # Deprecated `skip_cleanup` can now be avoided, `cleanup: false` is by default
+        edge: true
+        # Run `semantic-release`
+        script: 'npx semantic-release@15.14'

.yamllint

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+# Extend the `default` configuration provided by `yamllint`
+extends: default
+
+# Files to ignore completely
+# 1. All YAML files under directory `node_modules/`, introduced during the Travis run
+# 2. Any SLS files under directory `test/`, which are actually state files
+# 3. Any YAML files under directory `.kitchen/`, introduced during local testing
+ignore: |
+  node_modules/
+  test/**/states/**/*.sls
+  .kitchen/
+
+yaml-files:
+  # Default settings
+  - '*.yaml'
+  - '*.yml'
+  - .salt-lint
+  - .yamllint
+  # SaltStack Formulas additional settings
+  - '*.example'
+  - test/**/*.sls
+
+rules:
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  line-length:
+    # Increase from default of `80`
+    # Based on https://github.com/PyCQA/flake8-bugbear#opinionated-warnings (`B950`)
+    max: 88
+  octal-values:
+    forbid-implicit-octal: true
+    forbid-explicit-octal: true

Gemfile

@@ -1,6 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gem 'kitchen-docker', '>= 2.9'
-gem 'kitchen-salt', '>= 0.6.0'
 gem 'kitchen-inspec', '>= 1.1'
-
+gem 'kitchen-salt', '>= 0.6.0'
+# Latest versions of `train` cause failure when running `kitchen verify`
+# Downgrading to `3.2.0` until this is fixed upstream
+# https://github.com/inspec/train/pull/544#issuecomment-566055052
+gem 'train', '3.2.0'

bin/kitchen

@@ -8,22 +8,25 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path("../bundle", __FILE__)
+bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+    abort(
+      'Your `bin/bundle` was not generated by Bundler, '\
+      'so this binstub cannot run.  Replace `bin/bundle` by running '\
+      '`bundle binstubs bundler --force`, then run this command again.'
+    )
   end
 end
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("test-kitchen", "kitchen")
+load Gem.bin_path('test-kitchen', 'kitchen')