https://github.com/ssc-services/mega-linter-plugin-salt

https://github.com/ssc-services/mega-linter-plugin-salt

megalinter salt-lint saltstack

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ssc-services/mega-linter-plugin-salt
• Owner: ssc-services
• Created: 2022-11-28T11:01:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-19T16:56:50.000Z (12 months ago)
• Last Synced: 2024-11-05T12:03:04.525Z (2 months ago)
• Topics: megalinter, salt-lint, saltstack
• Homepage:
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mega-linter-plugin-salt

This is a linter plugin for the excellent [MegaLinter](https://oxsecurity.github.io/megalinter), checks Salt State files (SLS) for best practices and behavior that could potentially be improved.

## Usage

To enable this plugin into your Megalinter config, add the following in your `.mega-linter.yml`:

```yaml

PLUGINS:

  - https://raw.githubusercontent.com/ssc-services/mega-linter-plugin-salt/main/mega-linter-plugin-salt/salt.megalinter-descriptor.yml

ENABLE_LINTERS:

  - SALT_SALTLINT

```

By default, the plugin will scan all `*.sls` file on your project, which might be broader than you'd like, so you may want to tweak the file selection options using the usual parameters, including:

- `SALT_DIRECTORY`

- `SALT_SALTLINT_FILTER_REGEX_INCLUDE`

- `SALT_SALTLINT_FILTER_REGEX_EXCLUDE`

- `SALT_SALTLINT_FILE_EXTENSIONS`

- `SALT_SALTLINT_FILE_NAMES_REGEX`

For further information have look at the Documentation of [MegaLinter](https://megalinter.io/latest/).