Skip to content

Commit

Permalink
[chore] Switch CI to use markdownlint-cli2 (sous-chefs#778)
Browse files Browse the repository at this point in the history
* [chore] Switch CI to use markdownlint-cli2

* Fix headings!

* We don't actually mind having a single space before the yaml comment
  • Loading branch information
damacus authored Feb 28, 2023
1 parent b3d5f11 commit eb8f99b
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name: ci

jobs:
lint-unit:
uses: sous-chefs/.github/.github/workflows/lint-unit.yml@0.1.0
uses: sous-chefs/.github/.github/workflows/lint-unit.yml@2.0.0
permissions:
actions: write
checks: write
Expand Down
4 changes: 4 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
config:
ul-indent: false # MD007
line-length: false # MD013
no-duplicate-heading/no-duplicate-header: false # MD024
3 changes: 2 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"recommendations": [
"chef-software.chef",
"rebornix.ruby",
"editorconfig.editorconfig"
"editorconfig.editorconfig",
"DavidAnson.vscode-markdownlint"
]
}
2 changes: 2 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ rules:
max-spaces-inside: 1
min-spaces-inside-empty: -1
max-spaces-inside-empty: -1
comments:
min-spaces-from-content: 1
6 changes: 2 additions & 4 deletions documentation/resource_apache2_mod_auth_cas.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[back to resource list](https://github.com/sous-chefs/apache2#resources)

---

# apache2_mod_auth_cas

[back to resource list](https://github.com/sous-chefs/apache2#resources)

Enables apache2 module `mod_auth_cas`.

**Note: call this resource directly, not through `apache2_module`!**
Expand Down
18 changes: 8 additions & 10 deletions documentation/resource_apache2_mod_wsgi.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[back to resource list](https://github.com/sous-chefs/apache2#resources)

---

# apache2_mod_wsgi

[back to resource list](https://github.com/sous-chefs/apache2#resources)

Enables apache2 module `mod_wsgi`.

This resource will install and enable the Apache WSGI module. See `apache_mod_wsgi_package` for the platform-specific module package. By default it installs WSGI for Python 3 if available for the platform, otherwise falls back to Python 2. If installing Python and mod_wsgi outside of this resource, you should set `install_package` to `false` to avoid a possible version conflict.
Expand All @@ -17,9 +15,9 @@ This resource will call `_module` with the correct identifiers for you.

## Properties

| Name | Type | Default | Description |
| ---------------- | ------ | ---------------------------- | ------------------------------------------------- |
| module_name | String | `wsgi_module` | The name of the wsgi module. |
| so_filename | String | `apache_mod_wsgi_filename` | The filename of the module object. |
| package_name | String | `apache_mod_wsgi_package` | The package that contains the WSGI module itself. |
| install_package | Bool | `true` | Whether to install the WSGI module package. |
| Name | Type | Default | Description |
| --------------- | ------ | -------------------------- | ------------------------------------------------- |
| module_name | String | `wsgi_module` | The name of the wsgi module. |
| so_filename | String | `apache_mod_wsgi_filename` | The filename of the module object. |
| package_name | String | `apache_mod_wsgi_package` | The package that contains the WSGI module itself. |
| install_package | Bool | `true` | Whether to install the WSGI module package. |

0 comments on commit eb8f99b

Please sign in to comment.