feat(semantic-release): implement for this formula #270

myii · 2019-10-17T07:21:20Z

PR progress checklist (to be filled in by reviewers)

Changes to documentation are appropriate (or tick if not required)
Changes to tests are appropriate (or tick if not required)
Reviews completed

What type of PR is this?

Primary type

[build] Changes related to the build system
[chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
[ci] Changes to the continuous integration configuration
[feat] A new feature
[fix] A bug fix
[perf] A code change that improves performance
[refactor] A code change that neither fixes a bug nor adds a feature
[revert] A change used to revert a previous commit
[style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

[docs] Documentation changes
[test] Adding missing or correcting existing tests

Does this PR introduce a `BREAKING CHANGE`?

No.

Related issues and/or pull requests

Semi-automated using feat(formula): add apache-formula myii/ssf-formula#79

Describe the changes you're proposing

As is familiar by now, semantic-release PRs do not modify the functionality of the formula itself.

Note: InSpec has replaced Serverspect

The Serverspec test file has been converted to InSpec.

Lint issues resolved

`yamllint`

fix(yamllint): fix all errors

apache-formula$ yamllint -s .
./pillar.example
  2:1       warning  missing document start "---"  (document-start)
  5:26      warning  truthy value should be one of [false, true]  (truthy)
  50:18     warning  too few spaces before comment  (comments)
  51:16     warning  truthy value should be one of [false, true]  (truthy)
  52:57     warning  too few spaces before comment  (comments)
  52:89     error    line too long (104 > 88 characters)  (line-length)
  67:33     warning  truthy value should be one of [false, true]  (truthy)
  67:38     warning  too few spaces before comment  (comments)
  69:31     warning  too few spaces before comment  (comments)
  70:8      warning  missing starting space in comment  (comments)
  75:53     warning  too few spaces before comment  (comments)
  75:89     error    line too long (98 > 88 characters)  (line-length)
  76:55     warning  too few spaces before comment  (comments)
  76:89     error    line too long (101 > 88 characters)  (line-length)
  78:50     warning  too few spaces before comment  (comments)
  79:89     error    line too long (95 > 88 characters)  (line-length)
  82:47     warning  too few spaces before comment  (comments)
  83:54     warning  too few spaces before comment  (comments)
  83:89     error    line too long (100 > 88 characters)  (line-length)
  84:58     warning  too few spaces before comment  (comments)
  84:89     error    line too long (109 > 88 characters)  (line-length)
  93:32     warning  too few spaces before comment  (comments)
  100:89    error    line too long (105 > 88 characters)  (line-length)
  101:33    error    trailing spaces  (trailing-spaces)
  102:16    warning  truthy value should be one of [false, true]  (truthy)
  231:20    warning  truthy value should be one of [false, true]  (truthy)
  242:32    warning  too few spaces before comment  (comments)
  249:20    warning  truthy value should be one of [false, true]  (truthy)
  254:20    warning  truthy value should be one of [false, true]  (truthy)
  260:21    warning  truthy value should be one of [false, true]  (truthy)
  283:8     warning  missing starting space in comment  (comments)
  284:8     warning  missing starting space in comment  (comments)
  297:15    warning  too few spaces before comment  (comments)
  328:18    warning  truthy value should be one of [false, true]  (truthy)
  330:20    warning  truthy value should be one of [false, true]  (truthy)
  342:15    error    empty value in block mapping  (empty-values)
  345:18    warning  truthy value should be one of [false, true]  (truthy)
  348:18    warning  truthy value should be one of [false, true]  (truthy)
  355:18    warning  truthy value should be one of [false, true]  (truthy)
  358:89    error    line too long (91 > 88 characters)  (line-length)
  359:26    warning  truthy value should be one of [false, true]  (truthy)
  362:89    error    line too long (99 > 88 characters)  (line-length)
  365:89    error    line too long (267 > 88 characters)  (line-length)
  367:21    warning  truthy value should be one of [false, true]  (truthy)
  369:26    warning  truthy value should be one of [false, true]  (truthy)
  371:1     error    too many blank lines (1 > 0)  (empty-lines)

./apache/osfingermap.yaml
  3:1       warning  missing document start "---"  (document-start)

./apache/modsecurity.yaml
  4:1       warning  missing document start "---"  (document-start)
  6:18      warning  truthy value should be one of [false, true]  (truthy)
  7:20      warning  truthy value should be one of [false, true]  (truthy)
  14:18     warning  truthy value should be one of [false, true]  (truthy)
  15:20     warning  truthy value should be one of [false, true]  (truthy)
  22:18     warning  truthy value should be one of [false, true]  (truthy)
  23:20     warning  truthy value should be one of [false, true]  (truthy)

./apache/defaults.yaml
  4:1       warning  missing document start "---"  (document-start)
  5:26      warning  truthy value should be one of [false, true]  (truthy)
  7:19      warning  truthy value should be one of [false, true]  (truthy)
  10:18     warning  truthy value should be one of [false, true]  (truthy)
  11:20     warning  truthy value should be one of [false, true]  (truthy)

./apache/oscodenamemap.yaml
  4:1       warning  missing document start "---"  (document-start)
  4:8       error    trailing spaces  (trailing-spaces)
  9:8       error    trailing spaces  (trailing-spaces)
  14:7      error    trailing spaces  (trailing-spaces)
  19:6      error    trailing spaces  (trailing-spaces)
  24:8      error    trailing spaces  (trailing-spaces)
  29:9      error    trailing spaces  (trailing-spaces)
  34:7      error    trailing spaces  (trailing-spaces)
  39:8      error    trailing spaces  (trailing-spaces)
  44:8      error    trailing spaces  (trailing-spaces)
  50:9      error    trailing spaces  (trailing-spaces)
  61:1      error    too many blank lines (1 > 0)  (empty-lines)

./apache/osfamilymap.yaml
  4:1       warning  missing document start "---"  (document-start)
  16:89     error    line too long (104 > 88 characters)  (line-length)
  43:89     error    line too long (105 > 88 characters)  (line-length)
  56:16     warning  truthy value should be one of [false, true]  (truthy)
  114:11    error    empty value in block mapping  (empty-values)
  114:11    error    trailing spaces  (trailing-spaces)

./test/salt/pillar/default.sls
  5:26      warning  truthy value should be one of [false, true]  (truthy)
  7:18      warning  truthy value should be one of [false, true]  (truthy)
  8:20      warning  truthy value should be one of [false, true]  (truthy)

`salt-lint`

Fix salt-lint errors:
- Too numerous to be shown here -- all included in the commit logs.

Pillar / config required to test the proposed changes

Uses the test pillar in Kitchen.

Debug log showing how the proposed changes work

As shown in Travis.

Documentation checklist

Updated the README (e.g. Available states).
Updated pillar.example.

Testing checklist

Included in Kitchen (i.e. under state_top).
Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
Updated the relevant test pillar.

Additional context

* Automated using myii/ssf-formula#79

```bash apache-formula$ yamllint -s . ./pillar.example 2:1 warning missing document start "---" (document-start) 5:26 warning truthy value should be one of [false, true] (truthy) 50:18 warning too few spaces before comment (comments) 51:16 warning truthy value should be one of [false, true] (truthy) 52:57 warning too few spaces before comment (comments) 52:89 error line too long (104 > 88 characters) (line-length) 67:33 warning truthy value should be one of [false, true] (truthy) 67:38 warning too few spaces before comment (comments) 69:31 warning too few spaces before comment (comments) 70:8 warning missing starting space in comment (comments) 75:53 warning too few spaces before comment (comments) 75:89 error line too long (98 > 88 characters) (line-length) 76:55 warning too few spaces before comment (comments) 76:89 error line too long (101 > 88 characters) (line-length) 78:50 warning too few spaces before comment (comments) 79:89 error line too long (95 > 88 characters) (line-length) 82:47 warning too few spaces before comment (comments) 83:54 warning too few spaces before comment (comments) 83:89 error line too long (100 > 88 characters) (line-length) 84:58 warning too few spaces before comment (comments) 84:89 error line too long (109 > 88 characters) (line-length) 93:32 warning too few spaces before comment (comments) 100:89 error line too long (105 > 88 characters) (line-length) 101:33 error trailing spaces (trailing-spaces) 102:16 warning truthy value should be one of [false, true] (truthy) 231:20 warning truthy value should be one of [false, true] (truthy) 242:32 warning too few spaces before comment (comments) 249:20 warning truthy value should be one of [false, true] (truthy) 254:20 warning truthy value should be one of [false, true] (truthy) 260:21 warning truthy value should be one of [false, true] (truthy) 283:8 warning missing starting space in comment (comments) 284:8 warning missing starting space in comment (comments) 297:15 warning too few spaces before comment (comments) 328:18 warning truthy value should be one of [false, true] (truthy) 330:20 warning truthy value should be one of [false, true] (truthy) 342:15 error empty value in block mapping (empty-values) 345:18 warning truthy value should be one of [false, true] (truthy) 348:18 warning truthy value should be one of [false, true] (truthy) 355:18 warning truthy value should be one of [false, true] (truthy) 358:89 error line too long (91 > 88 characters) (line-length) 359:26 warning truthy value should be one of [false, true] (truthy) 362:89 error line too long (99 > 88 characters) (line-length) 365:89 error line too long (267 > 88 characters) (line-length) 367:21 warning truthy value should be one of [false, true] (truthy) 369:26 warning truthy value should be one of [false, true] (truthy) 371:1 error too many blank lines (1 > 0) (empty-lines) ./apache/osfingermap.yaml 3:1 warning missing document start "---" (document-start) ./apache/modsecurity.yaml 4:1 warning missing document start "---" (document-start) 6:18 warning truthy value should be one of [false, true] (truthy) 7:20 warning truthy value should be one of [false, true] (truthy) 14:18 warning truthy value should be one of [false, true] (truthy) 15:20 warning truthy value should be one of [false, true] (truthy) 22:18 warning truthy value should be one of [false, true] (truthy) 23:20 warning truthy value should be one of [false, true] (truthy) ./apache/defaults.yaml 4:1 warning missing document start "---" (document-start) 5:26 warning truthy value should be one of [false, true] (truthy) 7:19 warning truthy value should be one of [false, true] (truthy) 10:18 warning truthy value should be one of [false, true] (truthy) 11:20 warning truthy value should be one of [false, true] (truthy) ./apache/oscodenamemap.yaml 4:1 warning missing document start "---" (document-start) 4:8 error trailing spaces (trailing-spaces) 9:8 error trailing spaces (trailing-spaces) 14:7 error trailing spaces (trailing-spaces) 19:6 error trailing spaces (trailing-spaces) 24:8 error trailing spaces (trailing-spaces) 29:9 error trailing spaces (trailing-spaces) 34:7 error trailing spaces (trailing-spaces) 39:8 error trailing spaces (trailing-spaces) 44:8 error trailing spaces (trailing-spaces) 50:9 error trailing spaces (trailing-spaces) 61:1 error too many blank lines (1 > 0) (empty-lines) ./apache/osfamilymap.yaml 4:1 warning missing document start "---" (document-start) 16:89 error line too long (104 > 88 characters) (line-length) 43:89 error line too long (105 > 88 characters) (line-length) 56:16 warning truthy value should be one of [false, true] (truthy) 114:11 error empty value in block mapping (empty-values) 114:11 error trailing spaces (trailing-spaces) ./test/salt/pillar/default.sls 5:26 warning truthy value should be one of [false, true] (truthy) 7:18 warning truthy value should be one of [false, true] (truthy) 8:20 warning truthy value should be one of [false, true] (truthy) ```

```bash Examining apache/files/Debian/apache-2.2.config.jinja of type state [201] Trailing whitespace apache/files/Debian/apache-2.2.config.jinja:119 MaxSpareThreads 75 [201] Trailing whitespace apache/files/Debian/apache-2.2.config.jinja:136 MaxSpareThreads 75 ```

```bash Examining apache/files/FreeBSD/apache-2.4.config.jinja of type state [201] Trailing whitespace apache/files/FreeBSD/apache-2.4.config.jinja:171 ```

```bash Examining apache/files/RedHat/modsecurity.conf.jinja of type state [201] Trailing whitespace apache/files/RedHat/modsecurity.conf.jinja:26 ```

```bash Examining apache/flags.sls of type state [201] Trailing whitespace apache/flags.sls:7 ```

```bash Examining apache/init.sls of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/init.sls:15 service.{{apache.service_state}}: [206] Jinja variables should have spaces before and after: {{ var_name }} apache/init.sls:30 - cmd: {{apache.custom_reload_command|default('apachectl graceful')}} [206] Jinja variables should have spaces before and after: {{ var_name }} apache/init.sls:41 - cmd: {{apache.custom_reload_command|default('apachectl graceful')}} ```

```bash Examining apache/map.jinja of type state [209] Jinja comment should have spaces before and after: {# comment #} apache/map.jinja:22 {## Merge the apache pillar ##} ```

```bash Examining apache/mod_geoip.sls of type state [201] Trailing whitespace apache/mod_geoip.sls:30 - source: ```

```bash Examining apache/modules.sls of type state [201] Trailing whitespace apache/modules.sls:49 [201] Trailing whitespace apache/modules.sls:84 ```

```bash Examining apache/server_status.sls of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/server_status.sls:7 {{apache.confdir}}/server-status{{apache.confext}}: ```

```bash Examining apache/uninstall.sls of type state [201] Trailing whitespace apache/uninstall.sls:2 ```

```bash Examining apache/vhosts/cleanup.sls of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/cleanup.sls:29 - onlyif: "test -L {{ dirpath}}/{{ filename }} || test -f {{ dirpath}}/{{ filename }}" ```

```bash Examining apache/vhosts/minimal.tmpl of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/minimal.tmpl:25 <VirtualHost {% for intf in vals.interfaces %} {{intf}}:{{ vals.port }}{% endfor -%}> ```

```bash Examining apache/vhosts/proxy.tmpl of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/proxy.tmpl:38 <VirtualHost {%- for intf in vals.interfaces %} {{intf}}:{{ vals.port }}{% endfor -%}> [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/proxy.tmpl:53 {% if site.get('SSLCertificateChainFile') %}SSLCertificateChainFile {{ site.SSLCertificateChainFile}}{% endif %} [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/proxy.tmpl:85 {%- if lvals.get('Require') != False %}Require {{lvals.Require}}{% endif %} [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/proxy.tmpl:102 {%- if lmvals.get('Require') != False %}Require {{lmvals.Require}}{% endif %} ```

```bash Examining apache/vhosts/redirect.tmpl of type state [201] Trailing whitespace apache/vhosts/redirect.tmpl:23 [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/redirect.tmpl:28 <VirtualHost {%- for intf in vals.interfaces %} {{intf}}:{{ vals.port }}{% endfor -%}> [201] Trailing whitespace apache/vhosts/redirect.tmpl:47 ```

```bash Examining apache/vhosts/standard.tmpl of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/standard.tmpl:46 <VirtualHost {% for intf in vals.interfaces %} {{intf}}:{{ vals.port }}{% endfor -%}> [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/standard.tmpl:70 {% if site.get('SSLCertificateChainFile') %}SSLCertificateChainFile {{ site.SSLCertificateChainFile}}{% endif %} [201] Trailing whitespace apache/vhosts/standard.tmpl:72 [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/standard.tmpl:96 {% if dvals.get('Require') != False %}Require {{dvals.Require}}{% endif %} [206] Jinja variables should have spaces before and after: {{ var_name }} apache/vhosts/standard.tmpl:120 {%- if lvals.get('Require') != False %}Require {{lvals.Require}}{% endif %} ```

myii · 2019-10-17T07:36:57Z

@alxwr @k-hamza Once this PR is merged, the develop-v1.0.0 branch can be merged into master, in a similar set of steps to how we've promoted other ng formulas. That's outlined here:

[FEATURE] Promote ng version fail2ban-formula#34 (comment)

aboe76 · 2019-10-20T11:55:23Z

@myii merged it.

saltstack-formulas-travis · 2019-10-20T12:05:47Z

🎉 This PR is included in version 0.38.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

myii · 2019-10-20T15:01:15Z

Thanks @aboe76.

myii added 18 commits October 17, 2019 08:18

feat(semantic-release): implement for this formula

34d1f7c

* Automated using myii/ssf-formula#79

test(mod_security_spec): convert from Serverspec to InSpec

68b971b

fix(apache-2.4.config.jinja): fix salt-lint errors

e2c1c2e

```bash Examining apache/files/FreeBSD/apache-2.4.config.jinja of type state [201] Trailing whitespace apache/files/FreeBSD/apache-2.4.config.jinja:171 ```

fix(modsecurity.conf.jinja): fix salt-lint errors

2a79d05

```bash Examining apache/files/RedHat/modsecurity.conf.jinja of type state [201] Trailing whitespace apache/files/RedHat/modsecurity.conf.jinja:26 ```

fix(flags.sls): fix salt-lint errors

a146c59

```bash Examining apache/flags.sls of type state [201] Trailing whitespace apache/flags.sls:7 ```

fix(map.jinja): fix salt-lint errors

d011324

```bash Examining apache/map.jinja of type state [209] Jinja comment should have spaces before and after: {# comment #} apache/map.jinja:22 {## Merge the apache pillar ##} ```

fix(mod_geoip.sls): fix salt-lint errors

e55ef9b

```bash Examining apache/mod_geoip.sls of type state [201] Trailing whitespace apache/mod_geoip.sls:30 - source: ```

fix(modules.sls): fix salt-lint errors

55d11f8

```bash Examining apache/modules.sls of type state [201] Trailing whitespace apache/modules.sls:49 [201] Trailing whitespace apache/modules.sls:84 ```

fix(server_status.sls): fix salt-lint errors

da9a592

```bash Examining apache/server_status.sls of type state [206] Jinja variables should have spaces before and after: {{ var_name }} apache/server_status.sls:7 {{apache.confdir}}/server-status{{apache.confext}}: ```

fix(uninstall.sls): fix salt-lint errors

ed7dc7b

```bash Examining apache/uninstall.sls of type state [201] Trailing whitespace apache/uninstall.sls:2 ```

myii force-pushed the feat/implement-semantic-release branch from f0121ae to 1bad58d Compare October 17, 2019 07:32

myii added 2 commits October 17, 2019 09:12

docs(formula): use standard structure

701929d

docs(readme): move to docs/ directory and modify accordingly

6933f0e

myii force-pushed the feat/implement-semantic-release branch from f60afd7 to 6933f0e Compare October 17, 2019 08:12

aboe76 requested review from alxwr, javierbertoli and noelmcloughlin October 18, 2019 10:18

aboe76 approved these changes Oct 18, 2019

View reviewed changes

aboe76 merged commit 34324bd into saltstack-formulas:master Oct 20, 2019

saltstack-formulas-travis added the released label Oct 20, 2019

myii deleted the feat/implement-semantic-release branch October 20, 2019 15:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(semantic-release): implement for this formula #270

feat(semantic-release): implement for this formula #270

myii commented Oct 17, 2019 •

edited by aboe76

Loading

myii commented Oct 17, 2019

aboe76 commented Oct 20, 2019

saltstack-formulas-travis commented Oct 20, 2019

myii commented Oct 20, 2019

feat(semantic-release): implement for this formula #270

feat(semantic-release): implement for this formula #270

Conversation

myii commented Oct 17, 2019 • edited by aboe76 Loading

PR progress checklist (to be filled in by reviewers)

What type of PR is this?

Primary type

Secondary type

Does this PR introduce a BREAKING CHANGE?

Related issues and/or pull requests

Describe the changes you're proposing

Note: InSpec has replaced Serverspect

Lint issues resolved

yamllint

salt-lint

Pillar / config required to test the proposed changes

Debug log showing how the proposed changes work

Documentation checklist

Testing checklist

Additional context

myii commented Oct 17, 2019

aboe76 commented Oct 20, 2019

saltstack-formulas-travis commented Oct 20, 2019

myii commented Oct 20, 2019

myii commented Oct 17, 2019 •

edited by aboe76

Loading

Does this PR introduce a `BREAKING CHANGE`?

`yamllint`

`salt-lint`