ci(travis): use build config validation (beta) [skip ci]
* Automated using https://github.com/myii/ssf-formula/pull/97
This commit is contained in:
commit
5a6ed537d6
13 changed files with 141 additions and 263 deletions
|
@ -2,6 +2,7 @@
|
||||||
# vim: ft=yaml
|
# vim: ft=yaml
|
||||||
---
|
---
|
||||||
exclude_paths: []
|
exclude_paths: []
|
||||||
|
rules: {}
|
||||||
skip_list:
|
skip_list:
|
||||||
# Using `salt-lint` for linting other files as well, such as Jinja macros/templates
|
# Using `salt-lint` for linting other files as well, such as Jinja macros/templates
|
||||||
- 205 # Use ".sls" as a Salt State file extension
|
- 205 # Use ".sls" as a Salt State file extension
|
||||||
|
|
49
.travis.yml
49
.travis.yml
|
@ -3,6 +3,7 @@
|
||||||
---
|
---
|
||||||
## Machine config
|
## Machine config
|
||||||
dist: bionic
|
dist: bionic
|
||||||
|
version: '~> 1.0'
|
||||||
sudo: required
|
sudo: required
|
||||||
services:
|
services:
|
||||||
- docker
|
- docker
|
||||||
|
@ -33,8 +34,8 @@ jobs:
|
||||||
script:
|
script:
|
||||||
# Install and run `salt-lint`
|
# Install and run `salt-lint`
|
||||||
- pip install --user salt-lint
|
- pip install --user salt-lint
|
||||||
- git ls-files | grep '\.sls$\|\.jinja$\|\.j2$\|\.tmpl$'
|
- git ls-files | grep '\.sls$\|\.jinja$\|\.j2$\|\.tmpl$\|\.tst$'
|
||||||
| xargs -I {} salt-lint {}
|
| xargs salt-lint
|
||||||
# Install and run `yamllint`
|
# Install and run `yamllint`
|
||||||
# Need at least `v1.17.0` for the `yaml-files` setting
|
# Need at least `v1.17.0` for the `yaml-files` setting
|
||||||
- pip install --user yamllint>=1.17.0
|
- pip install --user yamllint>=1.17.0
|
||||||
|
@ -43,39 +44,41 @@ jobs:
|
||||||
- gem install rubocop
|
- gem install rubocop
|
||||||
- rubocop -d
|
- rubocop -d
|
||||||
# Install and run `commitlint`
|
# Install and run `commitlint`
|
||||||
- npm install @commitlint/config-conventional -D
|
- npm i -D @commitlint/config-conventional
|
||||||
- npm install @commitlint/travis-cli -D
|
@commitlint/travis-cli
|
||||||
- commitlint-travis
|
- commitlint-travis
|
||||||
|
|
||||||
## Define the rest of the matrix based on Kitchen testing
|
## Define the rest of the matrix based on Kitchen testing
|
||||||
# Make sure the instances listed below match up with
|
# Make sure the instances listed below match up with
|
||||||
# the `platforms` defined in `kitchen.yml`
|
# the `platforms` defined in `kitchen.yml`
|
||||||
- env: INSTANCE=default-debian-10-develop-py3
|
- env: INSTANCE=default-debian-10-master-py3
|
||||||
# - env: INSTANCE=default-ubuntu-1804-develop-py3
|
# - env: INSTANCE=default-ubuntu-1804-master-py3
|
||||||
# - env: INSTANCE=default-centos-7-develop-py3
|
# - env: INSTANCE=default-centos-8-master-py3
|
||||||
# - env: INSTANCE=default-fedora-30-develop-py3
|
# - env: INSTANCE=default-fedora-31-master-py3
|
||||||
# - env: INSTANCE=default-opensuse-leap-15-develop-py3
|
# - env: INSTANCE=default-opensuse-leap-151-master-py3
|
||||||
# - env: INSTANCE=default-amazonlinux-2-develop-py2
|
# - env: INSTANCE=default-amazonlinux-2-master-py2
|
||||||
# - env: INSTANCE=default-arch-base-latest-develop-py2
|
# - env: INSTANCE=default-arch-base-latest-master-py2
|
||||||
|
# - env: INSTANCE=default-debian-10-2019-2-py3
|
||||||
# - env: INSTANCE=default-debian-9-2019-2-py3
|
# - env: INSTANCE=default-debian-9-2019-2-py3
|
||||||
- env: INSTANCE=default-ubuntu-1804-2019-2-py3
|
- env: INSTANCE=default-ubuntu-1804-2019-2-py3
|
||||||
# - env: INSTANCE=default-centos-7-2019-2-py3
|
# - env: INSTANCE=default-centos-8-2019-2-py3
|
||||||
# - env: INSTANCE=default-fedora-30-2019-2-py3
|
# - env: INSTANCE=default-fedora-31-2019-2-py3
|
||||||
# - env: INSTANCE=default-opensuse-leap-15-2019-2-py3
|
- env: INSTANCE=default-opensuse-leap-151-2019-2-py3
|
||||||
|
# - env: INSTANCE=default-centos-7-2019-2-py2
|
||||||
- env: INSTANCE=default-amazonlinux-2-2019-2-py2
|
- env: INSTANCE=default-amazonlinux-2-2019-2-py2
|
||||||
- env: INSTANCE=default-arch-base-latest-2019-2-py2
|
# - env: INSTANCE=default-arch-base-latest-2019-2-py2
|
||||||
|
- env: INSTANCE=default-fedora-30-2018-3-py3
|
||||||
# - env: INSTANCE=default-debian-9-2018-3-py2
|
# - env: INSTANCE=default-debian-9-2018-3-py2
|
||||||
# - env: INSTANCE=default-ubuntu-1604-2018-3-py2
|
# - env: INSTANCE=default-ubuntu-1604-2018-3-py2
|
||||||
# - env: INSTANCE=default-centos-7-2018-3-py2
|
# - env: INSTANCE=default-centos-7-2018-3-py2
|
||||||
- env: INSTANCE=default-fedora-29-2018-3-py2
|
# - env: INSTANCE=default-opensuse-leap-151-2018-3-py2
|
||||||
- env: INSTANCE=default-opensuse-leap-15-2018-3-py2
|
|
||||||
# - env: INSTANCE=default-amazonlinux-2-2018-3-py2
|
# - env: INSTANCE=default-amazonlinux-2-2018-3-py2
|
||||||
# - env: INSTANCE=default-arch-base-latest-2018-3-py2
|
- env: INSTANCE=default-arch-base-latest-2018-3-py2
|
||||||
# - env: INSTANCE=default-debian-8-2017-7-py2
|
# - env: INSTANCE=default-debian-8-2017-7-py2
|
||||||
# - env: INSTANCE=default-ubuntu-1604-2017-7-py2
|
# - env: INSTANCE=default-ubuntu-1604-2017-7-py2
|
||||||
- env: INSTANCE=default-centos-6-2017-7-py2
|
- env: INSTANCE=default-centos-6-2017-7-py2
|
||||||
# - env: INSTANCE=default-fedora-29-2017-7-py2
|
# - env: INSTANCE=default-fedora-30-2017-7-py2
|
||||||
# - env: INSTANCE=default-opensuse-leap-15-2017-7-py2
|
# - env: INSTANCE=default-opensuse-leap-151-2017-7-py2
|
||||||
# - env: INSTANCE=default-amazonlinux-2-2017-7-py2
|
# - env: INSTANCE=default-amazonlinux-2-2017-7-py2
|
||||||
# - env: INSTANCE=default-arch-base-latest-2017-7-py2
|
# - env: INSTANCE=default-arch-base-latest-2017-7-py2
|
||||||
|
|
||||||
|
@ -93,9 +96,9 @@ jobs:
|
||||||
- maintainer contributor
|
- maintainer contributor
|
||||||
|
|
||||||
# Install all dependencies required for `semantic-release`
|
# Install all dependencies required for `semantic-release`
|
||||||
- npm install @semantic-release/changelog@3 -D
|
- npm i -D @semantic-release/changelog@3
|
||||||
- npm install @semantic-release/exec@3 -D
|
@semantic-release/exec@3
|
||||||
- npm install @semantic-release/git@7 -D
|
@semantic-release/git@7
|
||||||
deploy:
|
deploy:
|
||||||
provider: script
|
provider: script
|
||||||
skip_cleanup: true
|
skip_cleanup: true
|
||||||
|
|
|
@ -4,12 +4,12 @@ This list is sorted by the number of commits per contributor in _descending_ ord
|
||||||
|
|
||||||
Avatar|Contributor|Contributions
|
Avatar|Contributor|Contributions
|
||||||
:-:|---|:-:
|
:-:|---|:-:
|
||||||
|
<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/10231489?v=4' width='36' height='36' alt='@myii'>|[@myii](https://github.com/myii)|22
|
||||||
<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/3374962?v=4' width='36' height='36' alt='@nmadhok'>|[@nmadhok](https://github.com/nmadhok)|14
|
<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/3374962?v=4' width='36' height='36' alt='@nmadhok'>|[@nmadhok](https://github.com/nmadhok)|14
|
||||||
<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/1800660?v=4' width='36' height='36' alt='@aboe76'>|[@aboe76](https://github.com/aboe76)|10
|
<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/1800660?v=4' width='36' height='36' alt='@aboe76'>|[@aboe76](https://github.com/aboe76)|14
|
||||||
<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/10231489?v=4' width='36' height='36' alt='@myii'>|[@myii](https://github.com/myii)|9
|
|
||||||
<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/776662?v=4' width='36' height='36' alt='@carlosperello'>|[@carlosperello](https://github.com/carlosperello)|4
|
<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/776662?v=4' width='36' height='36' alt='@carlosperello'>|[@carlosperello](https://github.com/carlosperello)|4
|
||||||
<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/91293?v=4' width='36' height='36' alt='@whiteinge'>|[@whiteinge](https://github.com/whiteinge)|4
|
<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/91293?v=4' width='36' height='36' alt='@whiteinge'>|[@whiteinge](https://github.com/whiteinge)|4
|
||||||
<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/52996?v=4' width='36' height='36' alt='@daks'>|[@daks](https://github.com/daks)|3
|
<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/52996?v=4' width='36' height='36' alt='@daks'>|[@daks](https://github.com/daks)|4
|
||||||
<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/7460036?v=4' width='36' height='36' alt='@andrew-vant'>|[@andrew-vant](https://github.com/andrew-vant)|2
|
<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/7460036?v=4' width='36' height='36' alt='@andrew-vant'>|[@andrew-vant](https://github.com/andrew-vant)|2
|
||||||
<img class='float-left rounded-1' src='https://avatars1.githubusercontent.com/u/287147?v=4' width='36' height='36' alt='@techhat'>|[@techhat](https://github.com/techhat)|2
|
<img class='float-left rounded-1' src='https://avatars1.githubusercontent.com/u/287147?v=4' width='36' height='36' alt='@techhat'>|[@techhat](https://github.com/techhat)|2
|
||||||
<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/90042?v=4' width='36' height='36' alt='@kev009'>|[@kev009](https://github.com/kev009)|2
|
<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/90042?v=4' width='36' height='36' alt='@kev009'>|[@kev009](https://github.com/kev009)|2
|
||||||
|
@ -34,4 +34,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-17.
|
Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-10-11.
|
||||||
|
|
22
CHANGELOG.md
22
CHANGELOG.md
|
@ -1,5 +1,27 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [0.22.1](https://github.com/saltstack-formulas/sudoers-formula/compare/v0.22.0...v0.22.1) (2019-10-11)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **rubocop:** add fixes using `rubocop --safe-auto-correct` ([](https://github.com/saltstack-formulas/sudoers-formula/commit/652c350))
|
||||||
|
* **rubocop:** fix remaining errors manually ([](https://github.com/saltstack-formulas/sudoers-formula/commit/a10ea35))
|
||||||
|
|
||||||
|
|
||||||
|
### Continuous Integration
|
||||||
|
|
||||||
|
* **kitchen:** change `log_level` to `debug` instead of `info` ([](https://github.com/saltstack-formulas/sudoers-formula/commit/2821526))
|
||||||
|
* **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([](https://github.com/saltstack-formulas/sudoers-formula/commit/9719ac9))
|
||||||
|
* **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([](https://github.com/saltstack-formulas/sudoers-formula/commit/e63f441))
|
||||||
|
* **kitchen+travis:** replace EOL pre-salted images ([](https://github.com/saltstack-formulas/sudoers-formula/commit/dea2da0))
|
||||||
|
* **platform:** add `arch-base-latest` ([](https://github.com/saltstack-formulas/sudoers-formula/commit/55ce214))
|
||||||
|
* merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/sudoers-formula/commit/f3a98c2))
|
||||||
|
* merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/sudoers-formula/commit/96dcd0f))
|
||||||
|
* use `dist: bionic` & apply `opensuse-leap-15` SCP error workaround ([](https://github.com/saltstack-formulas/sudoers-formula/commit/7b44df2))
|
||||||
|
* **travis:** merge `rubocop` linter into main `lint` job ([](https://github.com/saltstack-formulas/sudoers-formula/commit/9df9a48))
|
||||||
|
* **yamllint:** add rule `empty-values` & use new `yaml-files` setting ([](https://github.com/saltstack-formulas/sudoers-formula/commit/5e22568))
|
||||||
|
|
||||||
# [0.22.0](https://github.com/saltstack-formulas/sudoers-formula/compare/v0.21.1...v0.22.0) (2019-08-17)
|
# [0.22.0](https://github.com/saltstack-formulas/sudoers-formula/compare/v0.21.1...v0.22.0) (2019-08-17)
|
||||||
|
|
||||||
|
|
||||||
|
|
2
FORMULA
2
FORMULA
|
@ -1,7 +1,7 @@
|
||||||
name: sudoers
|
name: sudoers
|
||||||
os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE
|
os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE
|
||||||
os_family: Debian, RedHat, Suse
|
os_family: Debian, RedHat, Suse
|
||||||
version: 0.22.0
|
version: 0.22.1
|
||||||
release: 1
|
release: 1
|
||||||
minimum_version: 2016.11
|
minimum_version: 2016.11
|
||||||
summary: Sudoers formula
|
summary: Sudoers formula
|
||||||
|
|
|
@ -13,15 +13,15 @@ This list is sorted by the number of commits per contributor in *descending* ord
|
||||||
* - Avatar
|
* - Avatar
|
||||||
- Contributor
|
- Contributor
|
||||||
- Contributions
|
- Contributions
|
||||||
|
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/10231489?v=4' width='36' height='36' alt='@myii'>`
|
||||||
|
- `@myii <https://github.com/myii>`_
|
||||||
|
- 22
|
||||||
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/3374962?v=4' width='36' height='36' alt='@nmadhok'>`
|
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/3374962?v=4' width='36' height='36' alt='@nmadhok'>`
|
||||||
- `@nmadhok <https://github.com/nmadhok>`_
|
- `@nmadhok <https://github.com/nmadhok>`_
|
||||||
- 14
|
- 14
|
||||||
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/1800660?v=4' width='36' height='36' alt='@aboe76'>`
|
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars0.githubusercontent.com/u/1800660?v=4' width='36' height='36' alt='@aboe76'>`
|
||||||
- `@aboe76 <https://github.com/aboe76>`_
|
- `@aboe76 <https://github.com/aboe76>`_
|
||||||
- 10
|
- 14
|
||||||
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/10231489?v=4' width='36' height='36' alt='@myii'>`
|
|
||||||
- `@myii <https://github.com/myii>`_
|
|
||||||
- 9
|
|
||||||
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/776662?v=4' width='36' height='36' alt='@carlosperello'>`
|
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/776662?v=4' width='36' height='36' alt='@carlosperello'>`
|
||||||
- `@carlosperello <https://github.com/carlosperello>`_
|
- `@carlosperello <https://github.com/carlosperello>`_
|
||||||
- 4
|
- 4
|
||||||
|
@ -30,7 +30,7 @@ This list is sorted by the number of commits per contributor in *descending* ord
|
||||||
- 4
|
- 4
|
||||||
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/52996?v=4' width='36' height='36' alt='@daks'>`
|
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars3.githubusercontent.com/u/52996?v=4' width='36' height='36' alt='@daks'>`
|
||||||
- `@daks <https://github.com/daks>`_
|
- `@daks <https://github.com/daks>`_
|
||||||
- 3
|
- 4
|
||||||
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/7460036?v=4' width='36' height='36' alt='@andrew-vant'>`
|
* - :raw-html-m2r:`<img class='float-left rounded-1' src='https://avatars2.githubusercontent.com/u/7460036?v=4' width='36' height='36' alt='@andrew-vant'>`
|
||||||
- `@andrew-vant <https://github.com/andrew-vant>`_
|
- `@andrew-vant <https://github.com/andrew-vant>`_
|
||||||
- 2
|
- 2
|
||||||
|
@ -98,4 +98,4 @@ This list is sorted by the number of commits per contributor in *descending* ord
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
Auto-generated by a `forked version <https://github.com/myii/maintainer>`_ of `gaocegege/maintainer <https://github.com/gaocegege/maintainer>`_ on 2019-08-17.
|
Auto-generated by a `forked version <https://github.com/myii/maintainer>`_ of `gaocegege/maintainer <https://github.com/gaocegege/maintainer>`_ on 2019-10-11.
|
||||||
|
|
|
@ -2,6 +2,31 @@
|
||||||
Changelog
|
Changelog
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
`0.22.1 <https://github.com/saltstack-formulas/sudoers-formula/compare/v0.22.0...v0.22.1>`_ (2019-10-11)
|
||||||
|
------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Bug Fixes
|
||||||
|
^^^^^^^^^
|
||||||
|
|
||||||
|
|
||||||
|
* **rubocop:** add fixes using ``rubocop --safe-auto-correct`` (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/652c350>`_\ )
|
||||||
|
* **rubocop:** fix remaining errors manually (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/a10ea35>`_\ )
|
||||||
|
|
||||||
|
Continuous Integration
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
|
||||||
|
* **kitchen:** change ``log_level`` to ``debug`` instead of ``info`` (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/2821526>`_\ )
|
||||||
|
* **kitchen:** install required packages to bootstrapped ``opensuse`` [skip ci] (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/9719ac9>`_\ )
|
||||||
|
* **kitchen:** use bootstrapped ``opensuse`` images until ``2019.2.2`` [skip ci] (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/e63f441>`_\ )
|
||||||
|
* **kitchen+travis:** replace EOL pre-salted images (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/dea2da0>`_\ )
|
||||||
|
* **platform:** add ``arch-base-latest`` (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/55ce214>`_\ )
|
||||||
|
* merge travis matrix, add ``salt-lint`` & ``rubocop`` to ``lint`` job (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/f3a98c2>`_\ )
|
||||||
|
* merge travis matrix, add ``salt-lint`` & ``rubocop`` to ``lint`` job (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/96dcd0f>`_\ )
|
||||||
|
* use ``dist: bionic`` & apply ``opensuse-leap-15`` SCP error workaround (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/7b44df2>`_\ )
|
||||||
|
* **travis:** merge ``rubocop`` linter into main ``lint`` job (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/9df9a48>`_\ )
|
||||||
|
* **yamllint:** add rule ``empty-values`` & use new ``yaml-files`` setting (\ ` <https://github.com/saltstack-formulas/sudoers-formula/commit/5e22568>`_\ )
|
||||||
|
|
||||||
`0.22.0 <https://github.com/saltstack-formulas/sudoers-formula/compare/v0.21.1...v0.22.0>`_ (2019-08-17)
|
`0.22.0 <https://github.com/saltstack-formulas/sudoers-formula/compare/v0.21.1...v0.22.0>`_ (2019-08-17)
|
||||||
------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
|
@ -1,159 +0,0 @@
|
||||||
.. _contributing:
|
|
||||||
|
|
||||||
How to contribute
|
|
||||||
=================
|
|
||||||
|
|
||||||
This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one.
|
|
||||||
What it already contains is information about *commit message formatting* and how that directly affects the numerous automated processes that are used for this repo.
|
|
||||||
It also covers how to contribute to this *formula's documentation*.
|
|
||||||
|
|
||||||
.. contents:: **Table of Contents**
|
|
||||||
|
|
||||||
Overview
|
|
||||||
--------
|
|
||||||
|
|
||||||
Submitting a pull request is more than just code!
|
|
||||||
To achieve a quality product, the *tests* and *documentation* need to be updated as well.
|
|
||||||
An excellent pull request will include these in the changes, wherever relevant.
|
|
||||||
|
|
||||||
Commit message formatting
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
Since every type of change requires making Git commits,
|
|
||||||
we will start by covering the importance of ensuring that all of your commit
|
|
||||||
messages are in the correct format.
|
|
||||||
|
|
||||||
Automation of multiple processes
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
This formula uses `semantic-release <https://github.com/semantic-release/semantic-release>`_ for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
|
|
||||||
The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation.
|
|
||||||
|
|
||||||
Full details are available in the upstream docs regarding the `Angular Commit Message Conventions <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines>`_.
|
|
||||||
The key factor is that the first line of the commit message must follow this format:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
type(scope): subject
|
|
||||||
|
|
||||||
|
|
||||||
* E.g. ``docs(contributing): add commit message formatting instructions``.
|
|
||||||
|
|
||||||
Besides the version bump, the changelog and release notes are formatted accordingly.
|
|
||||||
So based on the example above:
|
|
||||||
|
|
||||||
..
|
|
||||||
|
|
||||||
.. raw:: html
|
|
||||||
|
|
||||||
<h3>Documentation</h3>
|
|
||||||
|
|
||||||
* **contributing:** add commit message formatting instructions
|
|
||||||
|
|
||||||
|
|
||||||
* The ``type`` translates into a ``Documentation`` sub-heading.
|
|
||||||
* The ``(scope):`` will be shown in bold text without the brackets.
|
|
||||||
* The ``subject`` follows the ``scope`` as standard text.
|
|
||||||
|
|
||||||
Linting commit messages in Travis CI
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
This formula uses `commitlint <https://github.com/conventional-changelog/commitlint>`_ for checking commit messages during CI testing.
|
|
||||||
This ensures that they are in accordance with the ``semantic-release`` settings.
|
|
||||||
|
|
||||||
For more details about the default settings, refer back to the ``commitlint`` `reference rules <https://conventional-changelog.github.io/commitlint/#/reference-rules>`_.
|
|
||||||
|
|
||||||
Relationship between commit type and version bump
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
This formula applies some customisations to the defaults, as outlined in the table below,
|
|
||||||
based upon the `type <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type>`_ of the commit:
|
|
||||||
|
|
||||||
.. list-table::
|
|
||||||
:name: commit-type-vs-version-bump
|
|
||||||
:header-rows: 1
|
|
||||||
:stub-columns: 0
|
|
||||||
:widths: 1,2,3,1,1
|
|
||||||
|
|
||||||
* - Type
|
|
||||||
- Heading
|
|
||||||
- Description
|
|
||||||
- Bump (default)
|
|
||||||
- Bump (custom)
|
|
||||||
* - ``build``
|
|
||||||
- Build System
|
|
||||||
- Changes related to the build system
|
|
||||||
- –
|
|
||||||
-
|
|
||||||
* - ``chore``
|
|
||||||
- –
|
|
||||||
- Changes to the build process or auxiliary tools and libraries such as
|
|
||||||
documentation generation
|
|
||||||
- –
|
|
||||||
-
|
|
||||||
* - ``ci``
|
|
||||||
- Continuous Integration
|
|
||||||
- Changes to the continuous integration configuration
|
|
||||||
- –
|
|
||||||
-
|
|
||||||
* - ``docs``
|
|
||||||
- Documentation
|
|
||||||
- Documentation only changes
|
|
||||||
- –
|
|
||||||
- 0.0.1
|
|
||||||
* - ``feat``
|
|
||||||
- Features
|
|
||||||
- A new feature
|
|
||||||
- 0.1.0
|
|
||||||
-
|
|
||||||
* - ``fix``
|
|
||||||
- Bug Fixes
|
|
||||||
- A bug fix
|
|
||||||
- 0.0.1
|
|
||||||
-
|
|
||||||
* - ``perf``
|
|
||||||
- Performance Improvements
|
|
||||||
- A code change that improves performance
|
|
||||||
- 0.0.1
|
|
||||||
-
|
|
||||||
* - ``refactor``
|
|
||||||
- Code Refactoring
|
|
||||||
- A code change that neither fixes a bug nor adds a feature
|
|
||||||
- –
|
|
||||||
- 0.0.1
|
|
||||||
* - ``revert``
|
|
||||||
- Reverts
|
|
||||||
- A commit used to revert a previous commit
|
|
||||||
- –
|
|
||||||
- 0.0.1
|
|
||||||
* - ``style``
|
|
||||||
- Styles
|
|
||||||
- Changes that do not affect the meaning of the code (white-space,
|
|
||||||
formatting, missing semi-colons, etc.)
|
|
||||||
- –
|
|
||||||
- 0.0.1
|
|
||||||
* - ``test``
|
|
||||||
- Tests
|
|
||||||
- Adding missing or correcting existing tests
|
|
||||||
- –
|
|
||||||
- 0.0.1
|
|
||||||
|
|
||||||
Use ``BREAKING CHANGE`` to trigger a ``major`` version change
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message will **always** trigger a ``major`` version change, no matter which type has been used.
|
|
||||||
This will be appended to the changelog and release notes as well.
|
|
||||||
To preserve good formatting of these notes, the following format is prescribed:
|
|
||||||
|
|
||||||
* ``BREAKING CHANGE: <explanation in paragraph format>.``
|
|
||||||
|
|
||||||
An example of that:
|
|
||||||
|
|
||||||
.. code-block:: git
|
|
||||||
|
|
||||||
...
|
|
||||||
|
|
||||||
BREAKING CHANGE: With the removal of all of the `.sls` files under
|
|
||||||
`template package`, this formula no longer supports the installation of
|
|
||||||
packages.
|
|
||||||
|
|
|
@ -37,7 +37,7 @@ Contributing to this repo
|
||||||
|
|
||||||
**Commit message formatting is significant!!**
|
**Commit message formatting is significant!!**
|
||||||
|
|
||||||
Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
|
Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.
|
||||||
|
|
||||||
Available states
|
Available states
|
||||||
----------------
|
----------------
|
||||||
|
|
113
kitchen.yml
113
kitchen.yml
|
@ -11,88 +11,85 @@ driver:
|
||||||
# Make sure the platforms listed below match up with
|
# Make sure the platforms listed below match up with
|
||||||
# the `env.matrix` instances defined in `.travis.yml`
|
# the `env.matrix` instances defined in `.travis.yml`
|
||||||
platforms:
|
platforms:
|
||||||
## SALT `develop`
|
## SALT `master`
|
||||||
- name: debian-10-develop-py3
|
- name: debian-10-master-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-develop-py3:debian-10
|
image: netmanagers/salt-master-py3:debian-10
|
||||||
provision_command:
|
provision_command:
|
||||||
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
|
- sh bootstrap-salt.sh -XdPbfrq -x python3 git master
|
||||||
- name: ubuntu-1804-develop-py3
|
- name: ubuntu-1804-master-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-develop-py3:ubuntu-18.04
|
image: netmanagers/salt-master-py3:ubuntu-18.04
|
||||||
provision_command:
|
provision_command:
|
||||||
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
|
- sh bootstrap-salt.sh -XdPbfrq -x python3 git master
|
||||||
- name: centos-7-develop-py3
|
- name: centos-8-master-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-develop-py3:centos-7
|
image: netmanagers/salt-master-py3:centos-8
|
||||||
provision_command:
|
provision_command:
|
||||||
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
|
- sh bootstrap-salt.sh -XdPbfrq -x python3 git master
|
||||||
- name: fedora-30-develop-py3
|
- name: fedora-31-master-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-develop-py3:fedora-30
|
image: netmanagers/salt-master-py3:fedora-31
|
||||||
provision_command:
|
provision_command:
|
||||||
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- sh bootstrap-salt.sh -XdPbfrq -x python3 git develop
|
- sh bootstrap-salt.sh -XdPbfrq -x python3 git master
|
||||||
- name: opensuse-leap-15-develop-py3
|
- name: opensuse-leap-151-master-py3
|
||||||
driver:
|
driver:
|
||||||
image: opensuse/leap:15
|
image: netmanagers/salt-master-py3:opensuse-leap-15.1
|
||||||
provision_command:
|
provision_command:
|
||||||
# yamllint disable-line rule:line-length
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- zypper install -y glibc-locale net-tools net-tools-deprecated python-xml python3-pip
|
- sh bootstrap-salt.sh -XdPbfrq -x python3 git master
|
||||||
- systemctl enable sshd.service
|
|
||||||
run_command: /usr/lib/systemd/systemd
|
run_command: /usr/lib/systemd/systemd
|
||||||
provisioner:
|
# Workaround to avoid intermittent failures on `opensuse-leap-15.1`:
|
||||||
salt_bootstrap_options: -XdPfrq -x python3 git develop
|
|
||||||
salt_install: bootstrap
|
|
||||||
# Workaround to avoid intermittent failures on `opensuse-leap-15`:
|
|
||||||
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
||||||
transport:
|
transport:
|
||||||
max_ssh_sessions: 1
|
max_ssh_sessions: 1
|
||||||
- name: amazonlinux-2-develop-py2
|
# Use the `develop` image temporarily until the `master` image is available
|
||||||
|
# Not changing the name to minimise disruption across all of the formulas
|
||||||
|
- name: amazonlinux-2-master-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-develop-py2:amazonlinux-2
|
image: netmanagers/salt-develop-py2:amazonlinux-2
|
||||||
provision_command:
|
provision_command:
|
||||||
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- sh bootstrap-salt.sh -XdPbfrq -x python2 git develop
|
- sh bootstrap-salt.sh -XdPbfrq -x python2 git develop
|
||||||
- name: arch-base-latest-develop-py2
|
- name: arch-base-latest-master-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-develop-py2:arch-base-latest
|
image: netmanagers/salt-master-py2:arch-base-latest
|
||||||
provision_command:
|
provision_command:
|
||||||
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
- curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com
|
||||||
- sh bootstrap-salt.sh -XdPbfrq -x python2 git develop
|
- sh bootstrap-salt.sh -XdPbfrq -x python2 git master
|
||||||
run_command: /usr/lib/systemd/systemd
|
run_command: /usr/lib/systemd/systemd
|
||||||
|
|
||||||
## SALT `2019.2`
|
## SALT `2019.2`
|
||||||
|
- name: debian-10-2019-2-py3
|
||||||
|
driver:
|
||||||
|
image: netmanagers/salt-2019.2-py3:debian-10
|
||||||
- name: debian-9-2019-2-py3
|
- name: debian-9-2019-2-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2019.2-py3:debian-9
|
image: netmanagers/salt-2019.2-py3:debian-9
|
||||||
- name: ubuntu-1804-2019-2-py3
|
- name: ubuntu-1804-2019-2-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2019.2-py3:ubuntu-18.04
|
image: netmanagers/salt-2019.2-py3:ubuntu-18.04
|
||||||
- name: centos-7-2019-2-py3
|
- name: centos-8-2019-2-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2019.2-py3:centos-7
|
image: netmanagers/salt-2019.2-py3:centos-8
|
||||||
- name: fedora-30-2019-2-py3
|
- name: fedora-31-2019-2-py3
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2019.2-py3:fedora-30
|
image: netmanagers/salt-2019.2-py3:fedora-31
|
||||||
- name: opensuse-leap-15-2019-2-py3
|
- name: opensuse-leap-151-2019-2-py3
|
||||||
driver:
|
driver:
|
||||||
image: opensuse/leap:15
|
image: netmanagers/salt-2019.2-py3:opensuse-leap-15.1
|
||||||
provision_command:
|
|
||||||
# yamllint disable-line rule:line-length
|
|
||||||
- zypper install -y glibc-locale net-tools net-tools-deprecated python-xml python3-pip
|
|
||||||
- systemctl enable sshd.service
|
|
||||||
run_command: /usr/lib/systemd/systemd
|
run_command: /usr/lib/systemd/systemd
|
||||||
provisioner:
|
# Workaround to avoid intermittent failures on `opensuse-leap-15.1`:
|
||||||
salt_bootstrap_options: -XdPfrq -x python3 git 2019.2
|
|
||||||
salt_install: bootstrap
|
|
||||||
# Workaround to avoid intermittent failures on `opensuse-leap-15`:
|
|
||||||
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
||||||
transport:
|
transport:
|
||||||
max_ssh_sessions: 1
|
max_ssh_sessions: 1
|
||||||
|
- name: centos-7-2019-2-py2
|
||||||
|
driver:
|
||||||
|
image: netmanagers/salt-2019.2-py2:centos-7
|
||||||
- name: amazonlinux-2-2019-2-py2
|
- name: amazonlinux-2-2019-2-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2019.2-py2:amazonlinux-2
|
image: netmanagers/salt-2019.2-py2:amazonlinux-2
|
||||||
|
@ -102,6 +99,9 @@ platforms:
|
||||||
run_command: /usr/lib/systemd/systemd
|
run_command: /usr/lib/systemd/systemd
|
||||||
|
|
||||||
## SALT `2018.3`
|
## SALT `2018.3`
|
||||||
|
- name: fedora-30-2018-3-py3
|
||||||
|
driver:
|
||||||
|
image: netmanagers/salt-2018.3-py3:fedora-30
|
||||||
- name: debian-9-2018-3-py2
|
- name: debian-9-2018-3-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2018.3-py2:debian-9
|
image: netmanagers/salt-2018.3-py2:debian-9
|
||||||
|
@ -111,21 +111,11 @@ platforms:
|
||||||
- name: centos-7-2018-3-py2
|
- name: centos-7-2018-3-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2018.3-py2:centos-7
|
image: netmanagers/salt-2018.3-py2:centos-7
|
||||||
- name: fedora-29-2018-3-py2
|
- name: opensuse-leap-151-2018-3-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2018.3-py2:fedora-29
|
image: netmanagers/salt-2018.3-py2:opensuse-leap-15.1
|
||||||
- name: opensuse-leap-15-2018-3-py2
|
|
||||||
driver:
|
|
||||||
image: opensuse/leap:15
|
|
||||||
provision_command:
|
|
||||||
# yamllint disable-line rule:line-length
|
|
||||||
- zypper install -y glibc-locale net-tools net-tools-deprecated python-xml python2-pip
|
|
||||||
- systemctl enable sshd.service
|
|
||||||
run_command: /usr/lib/systemd/systemd
|
run_command: /usr/lib/systemd/systemd
|
||||||
provisioner:
|
# Workaround to avoid intermittent failures on `opensuse-leap-15.1`:
|
||||||
salt_bootstrap_options: -XdPfrq -x python2 git 2018.3
|
|
||||||
salt_install: bootstrap
|
|
||||||
# Workaround to avoid intermittent failures on `opensuse-leap-15`:
|
|
||||||
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
||||||
transport:
|
transport:
|
||||||
max_ssh_sessions: 1
|
max_ssh_sessions: 1
|
||||||
|
@ -148,21 +138,14 @@ platforms:
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2017.7-py2:centos-6
|
image: netmanagers/salt-2017.7-py2:centos-6
|
||||||
run_command: /sbin/init
|
run_command: /sbin/init
|
||||||
- name: fedora-29-2017-7-py2
|
- name: fedora-30-2017-7-py2
|
||||||
driver:
|
driver:
|
||||||
image: netmanagers/salt-2017.7-py2:fedora-29
|
image: netmanagers/salt-2017.7-py2:fedora-30
|
||||||
- name: opensuse-leap-15-2017-7-py2
|
- name: opensuse-leap-151-2017-7-py2
|
||||||
driver:
|
driver:
|
||||||
image: opensuse/leap:15
|
image: netmanagers/salt-2017.7-py2:opensuse-leap-15.1
|
||||||
provision_command:
|
|
||||||
# yamllint disable-line rule:line-length
|
|
||||||
- zypper install -y glibc-locale net-tools net-tools-deprecated python-xml python2-pip
|
|
||||||
- systemctl enable sshd.service
|
|
||||||
run_command: /usr/lib/systemd/systemd
|
run_command: /usr/lib/systemd/systemd
|
||||||
provisioner:
|
# Workaround to avoid intermittent failures on `opensuse-leap-15.1`:
|
||||||
salt_bootstrap_options: -XdPfrq -x python2 git 2017.7
|
|
||||||
salt_install: bootstrap
|
|
||||||
# Workaround to avoid intermittent failures on `opensuse-leap-15`:
|
|
||||||
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
# => SCP did not finish successfully (255): (Net::SCP::Error)
|
||||||
transport:
|
transport:
|
||||||
max_ssh_sessions: 1
|
max_ssh_sessions: 1
|
||||||
|
|
|
@ -63,7 +63,7 @@ module.exports = {
|
||||||
}
|
}
|
||||||
|
|
||||||
if (typeof commit.hash === `string`) {
|
if (typeof commit.hash === `string`) {
|
||||||
commit.hash = commit.hash.substring(0, 7)
|
commit.shortHash = commit.hash.substring(0, 7)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (typeof commit.subject === `string`) {
|
if (typeof commit.subject === `string`) {
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
control 'Sudoers configuration' do
|
control 'Sudoers configuration' do
|
||||||
title 'should match desired lines'
|
title 'should match desired lines'
|
||||||
|
|
||||||
|
@ -8,7 +10,9 @@ control 'Sudoers configuration' do
|
||||||
its('mode') { should cmp '0440' }
|
its('mode') { should cmp '0440' }
|
||||||
its('content') { should include 'Defaults:ADMINS !lecture' }
|
its('content') { should include 'Defaults:ADMINS !lecture' }
|
||||||
its('content') { should include 'Defaults:johndoe !requiretty' }
|
its('content') { should include 'Defaults:johndoe !requiretty' }
|
||||||
its('content') { should include 'Defaults@www1 log_year, logfile=/var/log/sudo.log' }
|
its('content') do
|
||||||
|
should include 'Defaults@www1 log_year, logfile=/var/log/sudo.log'
|
||||||
|
end
|
||||||
its('content') { should include 'Host_Alias WEBSERVERS = www1,www2,www3' }
|
its('content') { should include 'Host_Alias WEBSERVERS = www1,www2,www3' }
|
||||||
its('content') { should include 'User_Alias ADMINS = millert,dowdy,mikef' }
|
its('content') { should include 'User_Alias ADMINS = millert,dowdy,mikef' }
|
||||||
its('content') { should include 'johndoe ALL=(ALL) ALL' }
|
its('content') { should include 'johndoe ALL=(ALL) ALL' }
|
||||||
|
@ -17,7 +21,6 @@ control 'Sudoers configuration' do
|
||||||
its('content') { should include '%sudo ALL=(nodejs) NOPASSWD: ALL' }
|
its('content') { should include '%sudo ALL=(nodejs) NOPASSWD: ALL' }
|
||||||
its('content') { should include '+sysadmins ALL=(ALL) ALL' }
|
its('content') { should include '+sysadmins ALL=(ALL) ALL' }
|
||||||
its('content') { should include '#includedir /etc/sudoers.d' }
|
its('content') { should include '#includedir /etc/sudoers.d' }
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
describe file('/etc/sudoers.d/extra-file') do
|
describe file('/etc/sudoers.d/extra-file') do
|
||||||
|
@ -43,5 +46,4 @@ control 'Sudoers configuration' do
|
||||||
its('mode') { should cmp '0440' }
|
its('mode') { should cmp '0440' }
|
||||||
its('content') { should include '+other_netgroup ALL=(ALL) ALL' }
|
its('content') { should include '+other_netgroup ALL=(ALL) ALL' }
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
control 'Sudo package' do
|
control 'Sudo package' do
|
||||||
title 'should be installed'
|
title 'should be installed'
|
||||||
|
|
Loading…
Reference in a new issue