feat: use `semantic-release` cross-formula standard structure
* Semi-automated using https://github.com/myii/ssf-formula/pull/31
* Includes:
- Update TOFS
- Use `bin/kitchen`
- Use `dist: bionic` in Travis
- Add `yamllint` and apply rules
- Use `pillars_from_files` throughout
- Replace EOL images in Kitchen & Travis
- Add `develop` images in Kitchen & Travis
* Fix (or ignore) errors shown below:
```bash
salt-formula$ yamllint -s .
./pillar.example
1:1 warning missing document start "---" (document-start)
5:23 warning truthy value should be one of [false, true] (truthy)
8:25 warning truthy value should be one of [false, true] (truthy)
11:25 warning truthy value should be one of [false, true] (truthy)
19:21 warning truthy value should be one of [false, true] (truthy)
40:89 error line too long (108 > 88 characters) (line-length)
41:89 error line too long (112 > 88 characters) (line-length)
43:89 error line too long (112 > 88 characters) (line-length)
45:89 error line too long (110 > 88 characters) (line-length)
47:89 error line too long (89 > 88 characters) (line-length)
74:27 warning truthy value should be one of [false, true] (truthy)
82:9 error wrong indentation: expected 10 but found 8 (indentation)
101:14 warning truthy value should be one of [false, true] (truthy)
102:20 warning truthy value should be one of [false, true] (truthy)
103:89 error line too long (119 > 88 characters) (line-length)
121:7 warning comment not indented like content (comments-indentation)
122:24 error syntax error: found character '%' that cannot start any token
310:89 error line too long (102 > 88 characters) (line-length)
330:89 error line too long (113 > 88 characters) (line-length)
433:1 error too many blank lines (1 > 0) (empty-lines)
./salt/osmap.yaml
4:2 error syntax error: found character '%' that cannot start any token
6:89 error line too long (93 > 88 characters) (line-length)
22:89 error line too long (137 > 88 characters) (line-length)
23:89 error line too long (134 > 88 characters) (line-length)
33:89 error line too long (149 > 88 characters) (line-length)
34:89 error line too long (146 > 88 characters) (line-length)
./salt/osfamilymap.yaml
4:2 error syntax error: found character '%' that cannot start any token
6:89 error line too long (94 > 88 characters) (line-length)
24:89 error line too long (149 > 88 characters) (line-length)
25:89 error line too long (146 > 88 characters) (line-length)
39:89 error line too long (105 > 88 characters) (line-length)
40:89 error line too long (127 > 88 characters) (line-length)
56:89 error line too long (101 > 88 characters) (line-length)
./salt/ospyvermap.yaml
4:1 warning missing document start "---" (document-start)
./salt/defaults.yaml
3:1 warning missing document start "---" (document-start)
7:21 warning truthy value should be one of [false, true] (truthy)
8:12 warning truthy value should be one of [false, true] (truthy)
9:23 warning truthy value should be one of [false, true] (truthy)
10:19 warning truthy value should be one of [false, true] (truthy)
14:25 warning truthy value should be one of [false, true] (truthy)
15:25 warning truthy value should be one of [false, true] (truthy)
16:27 warning truthy value should be one of [false, true] (truthy)
17:27 warning truthy value should be one of [false, true] (truthy)
39:28 warning truthy value should be one of [false, true] (truthy)
41:28 warning truthy value should be one of [false, true] (truthy)
45:24 warning truthy value should be one of [false, true] (truthy)
49:30 warning truthy value should be one of [false, true] (truthy)
54:28 warning truthy value should be one of [false, true] (truthy)
63:25 warning truthy value should be one of [false, true] (truthy)
68:15 warning truthy value should be one of [false, true] (truthy)
```
2019-09-11 23:37:14 +02:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# vim: ft=yaml
|
|
|
|
---
|
2020-12-16 07:58:36 +01:00
|
|
|
################################################################################
|
|
|
|
# NOTE: This file is UNMAINTAINED; it is provided for references purposes only.
|
|
|
|
# No guarantees are tendered that this structure will work after 2020.
|
|
|
|
################################################################################
|
|
|
|
# * https://en.wikipedia.org/wiki/Travis_CI:
|
|
|
|
# - "... free open-source plans were removed in [sic] the end of 2020"
|
|
|
|
# - https://blog.travis-ci.com/2020-11-02-travis-ci-new-billing
|
|
|
|
# - https://ropensci.org/technotes/2020/11/19/moving-away-travis/
|
|
|
|
################################################################################
|
2019-10-09 19:35:20 +02:00
|
|
|
## Machine config
|
2019-11-16 21:10:48 +01:00
|
|
|
os: 'linux'
|
|
|
|
arch: 'amd64'
|
|
|
|
dist: 'bionic'
|
2019-11-13 17:53:13 +01:00
|
|
|
version: '~> 1.0'
|
2018-12-22 16:00:15 +01:00
|
|
|
|
2019-10-09 19:35:20 +02:00
|
|
|
## Language and cache config
|
2019-11-16 21:10:48 +01:00
|
|
|
language: 'ruby'
|
|
|
|
cache: 'bundler'
|
|
|
|
|
|
|
|
## Services config
|
|
|
|
services:
|
|
|
|
- docker
|
2018-12-22 16:00:15 +01:00
|
|
|
|
2019-10-09 19:35:20 +02:00
|
|
|
## Script to run for the test stage
|
2018-12-22 16:00:15 +01:00
|
|
|
script:
|
2019-10-09 19:35:20 +02:00
|
|
|
- bin/kitchen verify "${INSTANCE}"
|
2019-05-14 15:10:26 +02:00
|
|
|
|
2019-10-09 19:35:20 +02:00
|
|
|
## Stages and jobs matrix
|
|
|
|
stages:
|
|
|
|
- test
|
2020-12-16 07:58:36 +01:00
|
|
|
# # As part of the switch away from Travis CI, ensure that the `release` stage
|
|
|
|
# # is not run inadvertently
|
|
|
|
# - name: 'release'
|
|
|
|
# if: 'branch = master AND type != pull_request'
|
2019-05-14 15:10:26 +02:00
|
|
|
jobs:
|
|
|
|
include:
|
2019-10-09 19:35:20 +02:00
|
|
|
## Define the test stage that runs the linters (and testing matrix, if applicable)
|
|
|
|
|
2019-10-11 21:28:03 +02:00
|
|
|
# Run all of the linters in a single job
|
2019-11-16 21:10:48 +01:00
|
|
|
- language: 'node_js'
|
|
|
|
node_js: 'lts/*'
|
|
|
|
env: 'Lint'
|
2019-11-27 22:06:03 +01:00
|
|
|
name: 'Lint: salt-lint, yamllint, rubocop, shellcheck & commitlint'
|
2019-11-16 21:10:48 +01:00
|
|
|
before_install: 'skip'
|
2019-05-14 15:10:26 +02:00
|
|
|
script:
|
2019-10-09 19:35:20 +02:00
|
|
|
# Install and run `salt-lint`
|
|
|
|
- pip install --user salt-lint
|
2019-11-27 23:03:35 +01:00
|
|
|
- git ls-files -- '*.sls' '*.jinja' '*.j2' '*.tmpl' '*.tst'
|
2019-11-27 22:06:03 +01:00
|
|
|
| xargs salt-lint
|
feat: use `semantic-release` cross-formula standard structure
* Semi-automated using https://github.com/myii/ssf-formula/pull/31
* Includes:
- Update TOFS
- Use `bin/kitchen`
- Use `dist: bionic` in Travis
- Add `yamllint` and apply rules
- Use `pillars_from_files` throughout
- Replace EOL images in Kitchen & Travis
- Add `develop` images in Kitchen & Travis
* Fix (or ignore) errors shown below:
```bash
salt-formula$ yamllint -s .
./pillar.example
1:1 warning missing document start "---" (document-start)
5:23 warning truthy value should be one of [false, true] (truthy)
8:25 warning truthy value should be one of [false, true] (truthy)
11:25 warning truthy value should be one of [false, true] (truthy)
19:21 warning truthy value should be one of [false, true] (truthy)
40:89 error line too long (108 > 88 characters) (line-length)
41:89 error line too long (112 > 88 characters) (line-length)
43:89 error line too long (112 > 88 characters) (line-length)
45:89 error line too long (110 > 88 characters) (line-length)
47:89 error line too long (89 > 88 characters) (line-length)
74:27 warning truthy value should be one of [false, true] (truthy)
82:9 error wrong indentation: expected 10 but found 8 (indentation)
101:14 warning truthy value should be one of [false, true] (truthy)
102:20 warning truthy value should be one of [false, true] (truthy)
103:89 error line too long (119 > 88 characters) (line-length)
121:7 warning comment not indented like content (comments-indentation)
122:24 error syntax error: found character '%' that cannot start any token
310:89 error line too long (102 > 88 characters) (line-length)
330:89 error line too long (113 > 88 characters) (line-length)
433:1 error too many blank lines (1 > 0) (empty-lines)
./salt/osmap.yaml
4:2 error syntax error: found character '%' that cannot start any token
6:89 error line too long (93 > 88 characters) (line-length)
22:89 error line too long (137 > 88 characters) (line-length)
23:89 error line too long (134 > 88 characters) (line-length)
33:89 error line too long (149 > 88 characters) (line-length)
34:89 error line too long (146 > 88 characters) (line-length)
./salt/osfamilymap.yaml
4:2 error syntax error: found character '%' that cannot start any token
6:89 error line too long (94 > 88 characters) (line-length)
24:89 error line too long (149 > 88 characters) (line-length)
25:89 error line too long (146 > 88 characters) (line-length)
39:89 error line too long (105 > 88 characters) (line-length)
40:89 error line too long (127 > 88 characters) (line-length)
56:89 error line too long (101 > 88 characters) (line-length)
./salt/ospyvermap.yaml
4:1 warning missing document start "---" (document-start)
./salt/defaults.yaml
3:1 warning missing document start "---" (document-start)
7:21 warning truthy value should be one of [false, true] (truthy)
8:12 warning truthy value should be one of [false, true] (truthy)
9:23 warning truthy value should be one of [false, true] (truthy)
10:19 warning truthy value should be one of [false, true] (truthy)
14:25 warning truthy value should be one of [false, true] (truthy)
15:25 warning truthy value should be one of [false, true] (truthy)
16:27 warning truthy value should be one of [false, true] (truthy)
17:27 warning truthy value should be one of [false, true] (truthy)
39:28 warning truthy value should be one of [false, true] (truthy)
41:28 warning truthy value should be one of [false, true] (truthy)
45:24 warning truthy value should be one of [false, true] (truthy)
49:30 warning truthy value should be one of [false, true] (truthy)
54:28 warning truthy value should be one of [false, true] (truthy)
63:25 warning truthy value should be one of [false, true] (truthy)
68:15 warning truthy value should be one of [false, true] (truthy)
```
2019-09-11 23:37:14 +02:00
|
|
|
# Install and run `yamllint`
|
|
|
|
# Need at least `v1.17.0` for the `yaml-files` setting
|
|
|
|
- pip install --user yamllint>=1.17.0
|
|
|
|
- yamllint -s .
|
2019-10-11 21:28:03 +02:00
|
|
|
# Install and run `rubocop`
|
|
|
|
- gem install rubocop
|
|
|
|
- rubocop -d
|
2019-11-27 22:06:03 +01:00
|
|
|
# Run `shellcheck` (already pre-installed in Travis)
|
|
|
|
- shellcheck --version
|
2019-11-27 23:03:35 +01:00
|
|
|
- git ls-files -- '*.sh' '*.bash' '*.ksh'
|
2019-11-27 22:06:03 +01:00
|
|
|
| xargs shellcheck
|
feat: use `semantic-release` cross-formula standard structure
* Semi-automated using https://github.com/myii/ssf-formula/pull/31
* Includes:
- Update TOFS
- Use `bin/kitchen`
- Use `dist: bionic` in Travis
- Add `yamllint` and apply rules
- Use `pillars_from_files` throughout
- Replace EOL images in Kitchen & Travis
- Add `develop` images in Kitchen & Travis
* Fix (or ignore) errors shown below:
```bash
salt-formula$ yamllint -s .
./pillar.example
1:1 warning missing document start "---" (document-start)
5:23 warning truthy value should be one of [false, true] (truthy)
8:25 warning truthy value should be one of [false, true] (truthy)
11:25 warning truthy value should be one of [false, true] (truthy)
19:21 warning truthy value should be one of [false, true] (truthy)
40:89 error line too long (108 > 88 characters) (line-length)
41:89 error line too long (112 > 88 characters) (line-length)
43:89 error line too long (112 > 88 characters) (line-length)
45:89 error line too long (110 > 88 characters) (line-length)
47:89 error line too long (89 > 88 characters) (line-length)
74:27 warning truthy value should be one of [false, true] (truthy)
82:9 error wrong indentation: expected 10 but found 8 (indentation)
101:14 warning truthy value should be one of [false, true] (truthy)
102:20 warning truthy value should be one of [false, true] (truthy)
103:89 error line too long (119 > 88 characters) (line-length)
121:7 warning comment not indented like content (comments-indentation)
122:24 error syntax error: found character '%' that cannot start any token
310:89 error line too long (102 > 88 characters) (line-length)
330:89 error line too long (113 > 88 characters) (line-length)
433:1 error too many blank lines (1 > 0) (empty-lines)
./salt/osmap.yaml
4:2 error syntax error: found character '%' that cannot start any token
6:89 error line too long (93 > 88 characters) (line-length)
22:89 error line too long (137 > 88 characters) (line-length)
23:89 error line too long (134 > 88 characters) (line-length)
33:89 error line too long (149 > 88 characters) (line-length)
34:89 error line too long (146 > 88 characters) (line-length)
./salt/osfamilymap.yaml
4:2 error syntax error: found character '%' that cannot start any token
6:89 error line too long (94 > 88 characters) (line-length)
24:89 error line too long (149 > 88 characters) (line-length)
25:89 error line too long (146 > 88 characters) (line-length)
39:89 error line too long (105 > 88 characters) (line-length)
40:89 error line too long (127 > 88 characters) (line-length)
56:89 error line too long (101 > 88 characters) (line-length)
./salt/ospyvermap.yaml
4:1 warning missing document start "---" (document-start)
./salt/defaults.yaml
3:1 warning missing document start "---" (document-start)
7:21 warning truthy value should be one of [false, true] (truthy)
8:12 warning truthy value should be one of [false, true] (truthy)
9:23 warning truthy value should be one of [false, true] (truthy)
10:19 warning truthy value should be one of [false, true] (truthy)
14:25 warning truthy value should be one of [false, true] (truthy)
15:25 warning truthy value should be one of [false, true] (truthy)
16:27 warning truthy value should be one of [false, true] (truthy)
17:27 warning truthy value should be one of [false, true] (truthy)
39:28 warning truthy value should be one of [false, true] (truthy)
41:28 warning truthy value should be one of [false, true] (truthy)
45:24 warning truthy value should be one of [false, true] (truthy)
49:30 warning truthy value should be one of [false, true] (truthy)
54:28 warning truthy value should be one of [false, true] (truthy)
63:25 warning truthy value should be one of [false, true] (truthy)
68:15 warning truthy value should be one of [false, true] (truthy)
```
2019-09-11 23:37:14 +02:00
|
|
|
# Install and run `commitlint`
|
2019-10-31 11:35:46 +01:00
|
|
|
- npm i -D @commitlint/config-conventional
|
|
|
|
@commitlint/travis-cli
|
2019-05-14 15:10:26 +02:00
|
|
|
- commitlint-travis
|
2019-10-09 19:35:20 +02:00
|
|
|
|
2020-10-03 11:53:17 +02:00
|
|
|
# Run `pre-commit` linters in a single job
|
|
|
|
- language: 'python'
|
|
|
|
env: 'Lint_pre-commit'
|
|
|
|
name: 'Lint: pre-commit'
|
|
|
|
before_install: 'skip'
|
|
|
|
cache:
|
|
|
|
directories:
|
|
|
|
- $HOME/.cache/pre-commit
|
|
|
|
script:
|
|
|
|
# Install and run `pre-commit`
|
|
|
|
- pip install pre-commit==2.7.1
|
|
|
|
- pre-commit run --all-files --color always --verbose
|
|
|
|
- pre-commit run --color always --hook-stage manual --verbose commitlint-travis
|
|
|
|
|
2019-10-09 19:35:20 +02:00
|
|
|
## 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`
|
2020-06-23 09:41:25 +02:00
|
|
|
- env: INSTANCE=v3001-py3-debian-10-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-debian-9-3001-py3
|
|
|
|
- env: INSTANCE=v3001-py3-ubuntu-2004-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-ubuntu-1804-3001-py3
|
|
|
|
- env: INSTANCE=v3001-py3-centos-8-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-centos-7-3001-py3
|
|
|
|
- env: INSTANCE=v3001-py3-fedora-32-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-fedora-31-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-opensuse-leap-152-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-amazonlinux-2-3001-py3
|
|
|
|
- env: INSTANCE=v3001-py3-oraclelinux-8-3001-py3
|
|
|
|
# - env: INSTANCE=v3001-py3-oraclelinux-7-3001-py3
|
2020-10-12 10:29:41 +02:00
|
|
|
- env: INSTANCE=v3001-py3-gentoo-stage3-latest-3001-py3
|
|
|
|
- env: INSTANCE=v3001-py3-gentoo-stage3-systemd-3001-py3
|
2020-06-23 09:41:25 +02:00
|
|
|
# - env: INSTANCE=v3000-py3-debian-10-3000-3-py3
|
2020-05-14 08:13:33 +02:00
|
|
|
# - env: INSTANCE=v3000-py3-debian-9-3000-3-py3
|
|
|
|
# - env: INSTANCE=v3000-py3-ubuntu-1804-3000-3-py3
|
2020-06-23 09:41:25 +02:00
|
|
|
# - env: INSTANCE=v3000-py3-centos-8-3000-3-py3
|
2020-05-14 08:13:33 +02:00
|
|
|
# - env: INSTANCE=v3000-py3-centos-7-3000-3-py3
|
2020-05-26 02:31:06 +02:00
|
|
|
- env: INSTANCE=v3000-py3-opensuse-leap-152-3000-3-py3
|
2020-05-14 08:13:33 +02:00
|
|
|
- env: INSTANCE=v3000-py3-amazonlinux-2-3000-3-py3
|
2020-06-23 09:41:25 +02:00
|
|
|
# - env: INSTANCE=v3000-py3-oraclelinux-8-3000-3-py3
|
|
|
|
- env: INSTANCE=v3000-py3-oraclelinux-7-3000-3-py3
|
2020-05-14 08:13:33 +02:00
|
|
|
- env: INSTANCE=v3000-py2-ubuntu-1804-3000-3-py2
|
|
|
|
# - env: INSTANCE=v3000-py2-ubuntu-1604-3000-3-py2
|
2020-10-12 10:29:41 +02:00
|
|
|
# - env: INSTANCE=v3000-py3-gentoo-stage3-latest-3000-3-py3
|
|
|
|
# - env: INSTANCE=v3000-py3-gentoo-stage3-systemd-3000-3-py3
|
2019-10-09 19:35:20 +02:00
|
|
|
|
|
|
|
## Define the release stage that runs `semantic-release`
|
2019-11-16 21:10:48 +01:00
|
|
|
- stage: 'release'
|
|
|
|
language: 'node_js'
|
|
|
|
node_js: 'lts/*'
|
|
|
|
env: 'Release'
|
2019-10-09 19:35:20 +02:00
|
|
|
name: 'Run semantic-release inc. file updates to AUTHORS, CHANGELOG & FORMULA'
|
2019-11-16 21:10:48 +01:00
|
|
|
before_install: 'skip'
|
2019-05-14 15:10:26 +02:00
|
|
|
script:
|
|
|
|
# Update `AUTHORS.md`
|
|
|
|
- export MAINTAINER_TOKEN=${GH_TOKEN}
|
|
|
|
- go get github.com/myii/maintainer
|
|
|
|
- maintainer contributor
|
|
|
|
|
|
|
|
# Install all dependencies required for `semantic-release`
|
2019-10-31 11:35:46 +01:00
|
|
|
- npm i -D @semantic-release/changelog@3
|
|
|
|
@semantic-release/exec@3
|
|
|
|
@semantic-release/git@7
|
2019-05-14 15:10:26 +02:00
|
|
|
deploy:
|
2019-11-16 21:10:48 +01:00
|
|
|
provider: 'script'
|
2019-11-20 17:37:37 +01:00
|
|
|
# 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
|
2019-11-16 21:10:48 +01:00
|
|
|
# Run `semantic-release`
|
2019-12-22 02:02:06 +01:00
|
|
|
script: 'npx semantic-release@15.14'
|
2020-05-21 21:10:23 +02:00
|
|
|
|
|
|
|
# Notification options: `always`, `never` or `change`
|
|
|
|
notifications:
|
|
|
|
webhooks:
|
|
|
|
if: 'repo = saltstack-formulas/salt-formula'
|
|
|
|
urls:
|
|
|
|
- https://saltstack-formulas.zulipchat.com/api/v1/external/travis?api_key=HsIq3o5QmLxdnVCKF9is0FUIpkpAY79P&stream=CI&topic=saltstack-formulas%2Fsalt-formula&ignore_pull_requests=true
|
|
|
|
on_success: always # default: always
|
|
|
|
on_failure: always # default: always
|
|
|
|
on_start: always # default: never
|
|
|
|
on_cancel: always # default: always
|
|
|
|
on_error: always # default: always
|