Merge pull request saltstack-formulas#235 from myii/feat/implement-se…

…mantic-release

feat(semantic-release): implement for this formula

.gitignore

@@ -1,12 +1,40 @@
-.kitchen/
-.ruby-version
-junit*.xml
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+# Usually these files are written by a python script from a packager
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -15,5 +43,80 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
-*,cover
+*.cover
 .hypothesis/
+.kitchen
+.kitchen.local.yml
+kitchen.local.yml
+junit-*.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Bundler
+Gemfile.lock
+
+# copied `.md` files used for conversion to `.rst` using `m2r`
+docs/*.md
+
+# Vim
+*.sw?
+
+## Collected when centralising formulas (check and sort)
+# `collectd-formula`
+.pytest_cache/
+/.idea/
+Dockerfile.*_*
+ignore/
+tmp/

.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,17 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+exclude_paths: []
+rules:
+ 204: # Lines should be no longer that 160 chars
+ ignore: |
+ docker/repo.sls
+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,22 +1,104 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+## Machine config
+dist: bionic
 sudo: required
+services:
+ - docker
 
+## Language and cache config
+language: ruby
+cache: bundler
 
-language: python
+## Script to run for the test stage
+script:
+ - bin/kitchen verify "${INSTANCE}"
 
-services:
- - docker
+## Stages and jobs matrix
+stages:
+ - test
+ - name: release
+ if: branch = master AND type != pull_request
+jobs:
+ include:
+ ## Define the test stage that runs the linters (and testing matrix, if applicable)
 
-before_install:
- - bundle install
+ # Run all of the linters in a single job
+ - language: node_js
+ node_js: lts/*
+ env: Lint
+ name: 'Lint: salt-lint, yamllint, rubocop & 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
+ - yamllint -s .
+ # Install and run `rubocop`
+ - gem install rubocop
+ - rubocop -d
+ # Install and run `commitlint`
+ - npm install @commitlint/config-conventional -D
+ - npm install @commitlint/travis-cli -D
+ - commitlint-travis
 
+ ## 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
 
-env:
- matrix:
- - INSTANCE: default-ubuntu-1804
- - INSTANCE: default-debian-jessie
- - INSTANCE: default-debian-stretch
- - INSTANCE: version-1131-debian-jessie
- - INSTANCE: version-1131-debian-stretch
+ ## 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
 
-script:
- - bundle exec kitchen verify ${INSTANCE}
+ # 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
+ deploy:
+ provider: script
+ skip_cleanup: true
+ script:
+ # Run `semantic-release`
+ - npx semantic-release@15

.yamllint

@@ -0,0 +1,37 @@
+# -*- 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/
+ docker/osfamilymap.yaml
+
+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