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 b875961..80d5110 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,64 +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: - - INSTANCE: default-debian-10-develop-py3 - # - INSTANCE: default-ubuntu-1804-develop-py3 - # - INSTANCE: default-centos-7-develop-py3 - # - INSTANCE: default-fedora-30-develop-py3 - # - INSTANCE: default-opensuse-leap-15-develop-py3 - # - INSTANCE: default-amazonlinux-2-develop-py2 - # - INSTANCE: default-arch-base-latest-develop-py2 - # - INSTANCE: default-debian-9-2019-2-py3 - - INSTANCE: default-ubuntu-1804-2019-2-py3 - # - INSTANCE: default-centos-7-2019-2-py3 - # - INSTANCE: default-fedora-30-2019-2-py3 - # - INSTANCE: default-opensuse-leap-15-2019-2-py3 - - INSTANCE: default-amazonlinux-2-2019-2-py2 - - INSTANCE: default-arch-base-latest-2019-2-py2 - # - INSTANCE: default-debian-9-2018-3-py2 - # - INSTANCE: default-ubuntu-1604-2018-3-py2 - # - INSTANCE: default-centos-7-2018-3-py2 - - INSTANCE: default-fedora-29-2018-3-py2 - - INSTANCE: default-opensuse-leap-15-2018-3-py2 - # - INSTANCE: default-amazonlinux-2-2018-3-py2 - # - INSTANCE: default-arch-base-latest-2018-3-py2 - # - INSTANCE: default-debian-8-2017-7-py2 - # - INSTANCE: default-ubuntu-1604-2017-7-py2 - # - INSTANCE: default-centos-6-2017-7-py2 - # - INSTANCE: default-fedora-29-2017-7-py2 - # - INSTANCE: default-opensuse-leap-15-2017-7-py2 - # - INSTANCE: default-amazonlinux-2-2017-7-py2 - # - INSTANCE: default-arch-base-latest-2017-7-py2 +## 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 @@ -67,10 +46,56 @@ 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` + - env: INSTANCE=default-debian-10-develop-py3 + # - env: INSTANCE=default-ubuntu-1804-develop-py3 + # - env: INSTANCE=default-centos-7-develop-py3 + # - env: INSTANCE=default-fedora-30-develop-py3 + # - env: INSTANCE=default-opensuse-leap-15-develop-py3 + # - env: INSTANCE=default-amazonlinux-2-develop-py2 + # - env: INSTANCE=default-arch-base-latest-develop-py2 + # - env: INSTANCE=default-debian-9-2019-2-py3 + - env: INSTANCE=default-ubuntu-1804-2019-2-py3 + # - env: INSTANCE=default-centos-7-2019-2-py3 + # - env: INSTANCE=default-fedora-30-2019-2-py3 + # - env: INSTANCE=default-opensuse-leap-15-2019-2-py3 + - env: INSTANCE=default-amazonlinux-2-2019-2-py2 + - env: INSTANCE=default-arch-base-latest-2019-2-py2 + # - env: INSTANCE=default-debian-9-2018-3-py2 + # - env: INSTANCE=default-ubuntu-1604-2018-3-py2 + # - env: INSTANCE=default-centos-7-2018-3-py2 + - env: INSTANCE=default-fedora-29-2018-3-py2 + - env: INSTANCE=default-opensuse-leap-15-2018-3-py2 + # - env: INSTANCE=default-amazonlinux-2-2018-3-py2 + # - env: INSTANCE=default-arch-base-latest-2018-3-py2 + # - env: INSTANCE=default-debian-8-2017-7-py2 + # - env: INSTANCE=default-ubuntu-1604-2017-7-py2 + # - env: INSTANCE=default-centos-6-2017-7-py2 + # - env: INSTANCE=default-fedora-29-2017-7-py2 + # - env: INSTANCE=default-opensuse-leap-15-2017-7-py2 + # - env: INSTANCE=default-amazonlinux-2-2017-7-py2 + # - env: INSTANCE=default-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` diff --git a/AUTHORS.md b/AUTHORS.md index c676539..2a16f8c 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -4,8 +4,10 @@ This list is sorted by the number of commits per contributor in _descending_ ord Avatar|Contributor|Contributions :-:|---|:-: -@aboe76|[@aboe76](https://github.com/aboe76)|14 +@aboe76|[@aboe76](https://github.com/aboe76)|17 +@myii|[@myii](https://github.com/myii)|15 @babilen5|[@babilen5](https://github.com/babilen5)|7 +@n-rodriguez|[@n-rodriguez](https://github.com/n-rodriguez)|3 @nmadhok|[@nmadhok](https://github.com/nmadhok)|2 @zajk|[@zajk](https://github.com/zajk)|2 @puneetk|[@puneetk](https://github.com/puneetk)|2 @@ -15,4 +17,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-08-28. +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 ba5c4b6..9f061a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # Changelog +## [0.6.1](https://github.com/saltstack-formulas/sysctl-formula/compare/v0.6.0...v0.6.1) (2019-10-10) + + +### Bug Fixes + +* **map.jinja:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/sysctl-formula/commit/6a08317)) +* **package.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/sysctl-formula/commit/a8bbd25)) +* **param.sls:** fix `salt-lint` errors ([](https://github.com/saltstack-formulas/sysctl-formula/commit/50494dc)) + + +### Continuous Integration + +* **kitchen:** change `log_level` to `debug` instead of `info` ([](https://github.com/saltstack-formulas/sysctl-formula/commit/519d39b)) +* **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([](https://github.com/saltstack-formulas/sysctl-formula/commit/10a70f0)) +* **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([](https://github.com/saltstack-formulas/sysctl-formula/commit/1f2f4ce)) +* **platform:** add `arch-base-latest` ([](https://github.com/saltstack-formulas/sysctl-formula/commit/d9dfd4b)) +* **yamllint:** add rule `empty-values` & use new `yaml-files` setting ([](https://github.com/saltstack-formulas/sysctl-formula/commit/9fd2f1c)) +* merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/sysctl-formula/commit/9d202ba)) +* use `dist: bionic` & apply `opensuse-leap-15` SCP error workaround ([](https://github.com/saltstack-formulas/sysctl-formula/commit/c7e34a9)) + # [0.6.0](https://github.com/saltstack-formulas/sysctl-formula/compare/v0.5.0...v0.6.0) (2019-08-28) diff --git a/FORMULA b/FORMULA index 1398a80..58a1509 100644 --- a/FORMULA +++ b/FORMULA @@ -1,7 +1,7 @@ name: sysctl os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS, MacOS os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris, MacOS -version: 0.6.0 +version: 0.6.1 release: 0 minimum_version: 2017.7 summary: Sysctl formula 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 8023b17..a61a223 100644 --- a/docs/AUTHORS.rst +++ b/docs/AUTHORS.rst @@ -15,10 +15,16 @@ This list is sorted by the number of commits per contributor in *descending* ord - Contributions * - :raw-html-m2r:`@aboe76` - `@aboe76 `_ - - 14 + - 17 + * - :raw-html-m2r:`@myii` + - `@myii `_ + - 15 * - :raw-html-m2r:`@babilen5` - `@babilen5 `_ - 7 + * - :raw-html-m2r:`@n-rodriguez` + - `@n-rodriguez `_ + - 3 * - :raw-html-m2r:`@nmadhok` - `@nmadhok `_ - 2 @@ -41,4 +47,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-08-28. +Auto-generated by a `forked version `_ of `gaocegege/maintainer `_ on 2019-10-10. diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 7976791..897d117 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -2,6 +2,29 @@ Changelog ========= +`0.6.1 `_ (2019-10-10) +-------------------------------------------------------------------------------------------------------- + +Bug Fixes +^^^^^^^^^ + + +* **map.jinja:** fix ``salt-lint`` errors (\ ` `_\ ) +* **package.sls:** fix ``salt-lint`` errors (\ ` `_\ ) +* **param.sls:** fix ``salt-lint`` errors (\ ` `_\ ) + +Continuous Integration +^^^^^^^^^^^^^^^^^^^^^^ + + +* **kitchen:** change ``log_level`` to ``debug`` instead of ``info`` (\ ` `_\ ) +* **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`` (\ ` `_\ ) +* **yamllint:** add rule ``empty-values`` & use new ``yaml-files`` setting (\ ` `_\ ) +* merge travis matrix, add ``salt-lint`` & ``rubocop`` to ``lint`` job (\ ` `_\ ) +* use ``dist: bionic`` & apply ``opensuse-leap-15`` SCP error workaround (\ ` `_\ ) + `0.6.0 `_ (2019-08-28) -------------------------------------------------------------------------------------------------------- diff --git a/sysctl/map.jinja b/sysctl/map.jinja index d09c0e1..fd3c41f 100644 --- a/sysctl/map.jinja +++ b/sysctl/map.jinja @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=jinja -{## Start with defaults from defaults.sls and osfamilymap.yml ##} +{#- Start with defaults from defaults.sls and osfamilymap.yml #} {% import_yaml 'sysctl/defaults.yml' as default_settings %} {% import_yaml "sysctl/osfamilymap.yml" as os_family_map %} @@ -18,7 +18,7 @@ ) %} -{## Apply backwards compatiblility after merge ##} +{#- Apply backwards compatiblility after merge #} {% if default_settings['sysctl']['params'] is defined %} {% do default_settings['sysctl'].pop('params') %} {% endif %} @@ -26,7 +26,7 @@ {% do default_settings['sysctl'].pop('params2') %} {% endif %} -{## Merge in sysctl pillar ##} +{#- Merge in sysctl pillar #} {% set sysctl_settings = salt['pillar.get']( 'sysctl', default=default_settings['sysctl'], diff --git a/sysctl/package.sls b/sysctl/package.sls index 26b0517..5d9bb5b 100644 --- a/sysctl/package.sls +++ b/sysctl/package.sls @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=sls -{## import settings from map.jinja ##} +{#- import settings from map.jinja #} {%- from "sysctl/map.jinja" import sysctl_settings with context %} sysctl-pkg: diff --git a/sysctl/param.sls b/sysctl/param.sls index 65f5abf..1e46e41 100644 --- a/sysctl/param.sls +++ b/sysctl/param.sls @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=sls -{## import settings from map.jinja ##} +{#- import settings from map.jinja #} {%- from "sysctl/map.jinja" import sysctl_settings with context %} {% if sysctl_settings.params is defined %} @@ -22,7 +22,7 @@ sysctl-present-{{ param_name }}: {% endif %} {% endfor %} {% else %} -{## Support for legacy pillar structure ##} +{#- Support for legacy pillar structure #} {%- if sysctl_settings.lookup is defined %} {% if sysctl_settings.lookup.params2 is defined -%} {%- for param_name, param in sysctl_settings.lookup.get('params2', {}).items() -%}