diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 1cc8c26..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '[BUG] ' -labels: 'bug' -assignees: '' - ---- - - - -## Your setup -### Formula commit hash / release tag - - - - -### Versions reports (master & minion) - - - - -### Pillar / config used - - - - ---- - -## Bug details -### Describe the bug - - - - -### Steps to reproduce the bug - - - - - - -### Expected behaviour - - - - -### Attempts to fix the bug - - - - -### Additional context - - - - ---- - -### Meta: How can this template be improved? - - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index be8be36..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '[FEATURE] ' -labels: 'enhancement' -assignees: '' - ---- - - - -### Is your feature request related to a problem? - - - - -### Describe the solution you'd like - - - - -### Describe alternatives you've considered - - - - -### Additional context - - - - ---- - -### Meta: How can this template be improved? - - - diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..bdae9aa --- /dev/null +++ b/.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` diff --git a/.salt-lint b/.salt-lint new file mode 100644 index 0000000..a539954 --- /dev/null +++ b/.salt-lint @@ -0,0 +1,13 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- +exclude_paths: [] +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 diff --git a/.travis.yml b/.travis.yml index c134b00..a7b4f50 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,62 +1,43 @@ # -*- coding: utf-8 -*- # vim: ft=yaml --- +## Machine config dist: bionic -stages: - - test - - lint - - name: release - if: branch = master AND type != pull_request - sudo: required -cache: bundler -language: ruby - services: - docker -# Make sure the instances listed below match up with -# the `platforms` defined in `kitchen.yml` -env: - matrix: - # The ordering used below has been selected based on the time required in Travis - # The slower ones are kept as high up as possible, to run concurrently rather than - # slow down the entire run at the end (i.e. `centos-6` and `opensuse`) - # However, the groupings needed to be maintained in some semblance of order - # so this is a best-effort matrix, in the circumstances - # - INSTANCE: v201707-py2-debian-8-2017-7-py2 - - INSTANCE: v201707-py2-ubuntu-1604-2017-7-py2 - - INSTANCE: v201707-py2-centos-6-2017-7-py2 - # - INSTANCE: v201707-py2-amazonlinux-2-2017-7-py2 - # - INSTANCE: v201707-py2-arch-base-latest-2017-7-py2 - # - INSTANCE: v201803-py2-debian-9-2018-3-py2 - # - INSTANCE: v201803-py2-ubuntu-1604-2018-3-py2 - - INSTANCE: v201803-py2-centos-7-2018-3-py2 - - INSTANCE: v201803-py2-amazonlinux-2-2018-3-py2 - # - INSTANCE: v201803-py2-arch-base-latest-2018-3-py2 - - INSTANCE: v201902-py2-debian-9-2019-2-py2 - - INSTANCE: v201902-py2-ubuntu-1804-2019-2-py2 - # - INSTANCE: v201902-py2-centos-7-2019-2-py2 - # - INSTANCE: v201902-py2-opensuse-leap-15-2019-2-py2 - # - INSTANCE: v201902-py2-amazonlinux-2-2019-2-py2 - # - INSTANCE: v201902-py2-arch-base-latest-2019-2-py2 - # - INSTANCE: v201902-py3-debian-9-2019-2-py3 - # - INSTANCE: v201902-py3-ubuntu-1804-2019-2-py3 - # - INSTANCE: v201902-py3-centos-7-2019-2-py3 - - INSTANCE: v201902-py3-fedora-30-2019-2-py3 - - INSTANCE: v201902-py3-opensuse-leap-15-2019-2-py3 +## Language and cache config +language: ruby +cache: bundler +## 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: + allow_failures: + - env: Lint_rubocop + fast_finish: true include: - # Define the `lint` stage (runs `yamllint` and `commitlint`) - - stage: lint - language: node_js + ## Define the test stage that runs the linters (and testing matrix, if applicable) + + # Run all of the linters in a single job (except `rubocop`) + - language: node_js node_js: lts/* + env: Lint + name: 'Lint: salt-lint, yamllint & commitlint' before_install: skip script: + # Install and run `salt-lint` + - pip install --user salt-lint + - git ls-files | grep '\.sls$\|\.jinja$\|\.j2$\|\.tmpl$' + | xargs -I {} salt-lint {} # Install and run `yamllint` # Need at least `v1.17.0` for the `yaml-files` setting - pip install --user yamllint>=1.17.0 @@ -65,10 +46,54 @@ jobs: - npm install @commitlint/config-conventional -D - npm install @commitlint/travis-cli -D - commitlint-travis - # Define the release stage that runs `semantic-release` + # Run the `rubocop` linter in a separate job that is allowed to fail + # Once these lint errors are fixed, this can be merged into a single job + - language: node_js + node_js: lts/* + env: Lint_rubocop + name: 'Lint: rubocop' + before_install: skip + script: + # Install and run `rubocop` + - gem install rubocop + - rubocop -d + + ## 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` + # The ordering used below has been selected based on the time required in Travis + # The slower ones are kept as high up as possible, to run concurrently rather than + # slow down the entire run at the end (i.e. `centos-6` and `opensuse`) + # However, the groupings needed to be maintained in some semblance of order + # so this is a best-effort matrix, in the circumstances + # - env: INSTANCE=v201707-py2-debian-8-2017-7-py2 + - env: INSTANCE=v201707-py2-ubuntu-1604-2017-7-py2 + - env: INSTANCE=v201707-py2-centos-6-2017-7-py2 + # - env: INSTANCE=v201707-py2-amazonlinux-2-2017-7-py2 + # - env: INSTANCE=v201707-py2-arch-base-latest-2017-7-py2 + # - env: INSTANCE=v201803-py2-debian-9-2018-3-py2 + # - env: INSTANCE=v201803-py2-ubuntu-1604-2018-3-py2 + - env: INSTANCE=v201803-py2-centos-7-2018-3-py2 + - env: INSTANCE=v201803-py2-amazonlinux-2-2018-3-py2 + # - env: INSTANCE=v201803-py2-arch-base-latest-2018-3-py2 + - env: INSTANCE=v201902-py2-debian-9-2019-2-py2 + - env: INSTANCE=v201902-py2-ubuntu-1804-2019-2-py2 + # - env: INSTANCE=v201902-py2-centos-7-2019-2-py2 + # - env: INSTANCE=v201902-py2-opensuse-leap-15-2019-2-py2 + # - env: INSTANCE=v201902-py2-amazonlinux-2-2019-2-py2 + # - env: INSTANCE=v201902-py2-arch-base-latest-2019-2-py2 + # - env: INSTANCE=v201902-py3-debian-9-2019-2-py3 + # - env: INSTANCE=v201902-py3-ubuntu-1804-2019-2-py3 + # - env: INSTANCE=v201902-py3-centos-7-2019-2-py3 + - env: INSTANCE=v201902-py3-fedora-30-2019-2-py3 + - env: INSTANCE=v201902-py3-opensuse-leap-15-2019-2-py3 + + ## 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` diff --git a/AUTHORS.md b/AUTHORS.md index 016462a..05f8cca 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -7,7 +7,7 @@ Avatar|Contributor|Contributions @aboe76|[@aboe76](https://github.com/aboe76)|98 @gravyboat|[@gravyboat](https://github.com/gravyboat)|71 @nmadhok|[@nmadhok](https://github.com/nmadhok)|54 -@myii|[@myii](https://github.com/myii)|31 +@myii|[@myii](https://github.com/myii)|42 @iggy|[@iggy](https://github.com/iggy)|22 @puneetk|[@puneetk](https://github.com/puneetk)|21 @javierbertoli|[@javierbertoli](https://github.com/javierbertoli)|20 @@ -106,4 +106,4 @@ Avatar|Contributor|Contributions --- -Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-09-25. +Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-10-10. diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ecb72a..9c8d069 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Changelog +## [0.59.4](https://github.com/saltstack-formulas/salt-formula/compare/v0.59.3...v0.59.4) (2019-10-10) + + +### Bug Fixes + +* **map.jinja:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/salt-formula/commit/5b348eb)) +* **minion.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/salt-formula/commit/3e63977)) +* **syndic.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/salt-formula/commit/ef4ad1e)) + + +### Continuous Integration + +* **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([](https://github.com/saltstack-formulas/salt-formula/commit/8cc5952)) +* **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([](https://github.com/saltstack-formulas/salt-formula/commit/0c5eb7e)) +* **platform:** add `arch-base-latest` (commented out for now) [skip ci] ([](https://github.com/saltstack-formulas/salt-formula/commit/8f36788)) +* merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/salt-formula/commit/e815eaa)) + ## [0.59.3](https://github.com/saltstack-formulas/salt-formula/compare/v0.59.2...v0.59.3) (2019-09-25) diff --git a/FORMULA b/FORMULA index 4f552f7..e6b7404 100644 --- a/FORMULA +++ b/FORMULA @@ -1,7 +1,7 @@ name: salt os: Debian, Redhat, Suse, Arch, Gentoo, FreeBSD, Windows os_family: Debian, Redhat, Suse, Arch, Gentoo, FreeBSD, Windows -version: 0.59.3 +version: 0.59.4 release: 1 minimum_version: 2015.8 summary: Formula for install Saltstack diff --git a/Gemfile b/Gemfile index 3b36de3..5a232b6 100644 --- a/Gemfile +++ b/Gemfile @@ -1,6 +1,7 @@ -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' diff --git a/bin/kitchen b/bin/kitchen index 1cd44f3..dcfdb4c 100755 --- a/bin/kitchen +++ b/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') diff --git a/docs/AUTHORS.rst b/docs/AUTHORS.rst index c1f99d1..5d9c323 100644 --- a/docs/AUTHORS.rst +++ b/docs/AUTHORS.rst @@ -24,7 +24,7 @@ This list is sorted by the number of commits per contributor in *descending* ord - 54 * - :raw-html-m2r:`@myii` - `@myii `_ - - 31 + - 42 * - :raw-html-m2r:`@iggy` - `@iggy `_ - 22 @@ -314,4 +314,4 @@ This list is sorted by the number of commits per contributor in *descending* ord ---- -Auto-generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-09-25. +Auto-generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-10-10. diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index a2e32f8..3356380 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -2,6 +2,26 @@ Changelog ========= +`0.59.4 `_ (2019-10-10) +--------------------------------------------------------------------------------------------------------- + +Bug Fixes +^^^^^^^^^ + + +* **map.jinja:** fix ``salt-lint`` errors (\ ` `_\ ) +* **minion.sls:** fix ``salt-lint`` errors (\ ` `_\ ) +* **syndic.sls:** fix ``salt-lint`` errors (\ ` `_\ ) + +Continuous Integration +^^^^^^^^^^^^^^^^^^^^^^ + + +* **kitchen:** install required packages to bootstrapped ``opensuse`` [skip ci] (\ ` `_\ ) +* **kitchen:** use bootstrapped ``opensuse`` images until ``2019.2.2`` [skip ci] (\ ` `_\ ) +* **platform:** add ``arch-base-latest`` (commented out for now) [skip ci] (\ ` `_\ ) +* merge travis matrix, add ``salt-lint`` & ``rubocop`` to ``lint`` job (\ ` `_\ ) + `0.59.3 `_ (2019-09-25) --------------------------------------------------------------------------------------------------------- diff --git a/salt/map.jinja b/salt/map.jinja index 8c433b2..67f583d 100644 --- a/salt/map.jinja +++ b/salt/map.jinja @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=jinja -{## Start imports ##} +{#- Start imports #} {% import_yaml "salt/defaults.yaml" as defaults %} {% import_yaml "salt/osfamilymap.yaml" as osfamilymap %} {% import_yaml "salt/osmap.yaml" as osmap %} @@ -18,8 +18,8 @@ {% set lookup = salt['pillar.get']('salt:lookup', default={}, merge=True) %} {% do salt['defaults.merge'](defaults['salt'], lookup) %} -{## Merge in salt pillar ##} +{#- Merge in salt pillar #} {% set salt_settings = salt['pillar.get']('salt', default=defaults['salt'], merge=True) %} -{## Merge in salt_formulas pillar ##} +{#- Merge in salt_formulas pillar #} {% set formulas_settings = salt['pillar.get']('salt_formulas',default=defaults['salt_formulas'], merge=True) %} diff --git a/salt/minion.sls b/salt/minion.sls index e492a49..466fdb3 100644 --- a/salt/minion.sls +++ b/salt/minion.sls @@ -17,7 +17,7 @@ download-salt-minion: {% endif %} - user: root - group: wheel - - mode: 0644 + - mode: '0644' - unless: - test -n "{{ salt_settings.version }}" && '/opt/salt/bin/salt-minion --version=.*{{ salt_settings.version }}.*' - require_in: diff --git a/salt/syndic.sls b/salt/syndic.sls index 64a86b0..069ae7c 100644 --- a/salt/syndic.sls +++ b/salt/syndic.sls @@ -9,7 +9,7 @@ salt-syndic: - name: {{ salt_settings.salt_syndic }} {%- if salt_settings.version is defined %} - version: {{ salt_settings.version }} - {%- endif %} + {%- endif %} - require_in: - service: salt-syndic - watch_in: