Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roaldnefs/salt-lint-action

GitHub Action for running salt-lint as part of your workflows!
https://github.com/roaldnefs/salt-lint-action

github-actions salt-lint saltstack

Last synced: 3 months ago
JSON representation

GitHub Action for running salt-lint as part of your workflows!

Host: GitHub
URL: https://github.com/roaldnefs/salt-lint-action
Owner: roaldnefs
License: other
Created: 2019-10-06T13:13:43.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-08-17T06:14:17.000Z (over 3 years ago)
Last Synced: 2024-10-11T19:41:47.684Z (3 months ago)
Topics: github-actions, salt-lint, saltstack
Language: Shell
Size: 17.6 KB
Stars: 8
Watchers: 2
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Salt Lint for GitHub Action

This action allows you to run `salt-lint`.

The project is heavily based on [ansible-lint-action](https://github.com/ansible/ansible-lint-action), which was created by [Stefan Stölzle](/stoe) and is now maintained as part of the [Ansible](https://ansible.com/) by [Red Hat](https://redhat.com/) project.

## Usage

To use the action simply add the following lines to your `.github/workflows/main.yml`.

```yaml

on: [push]

jobs:

  test:

    runs-on: ubuntu-latest

    name: Salt Lint Action Demo

    steps:

    - uses: actions/checkout@v1

    - name: Run salt-lint

      uses: roaldnefs/salt-lint-action@master

      env:

        ACTION_STATE_NAME: init.sls

```

If you want to analyse all `^.*\.(sls|jinja|j2|tmpl|tst)$` files in the repository and increase logs verbosity use following env values instead:

```yaml

      env:

        ACTION_STATE_FIND_PATTERN: '^.*\.(sls|jinja|j2|tmpl|tst)$'

        ACTION_STATE_FIND_TYPE: 'regex'

        SALT_LINT_EXTRA_PARAMS: '-v'

```

N.B. Use `v0.0.1` or any other valid tag, or branch, or commit SHA instead of `master` to pin the action to use a specific version.

### Environment Variables

- **ACTION_STATE_NAME**: (optional) defaults to `init.sls`

- **ACTION_STATE_FIND_PATH**: (optional) when defined, `find` command is used for searching salt files matching a pattern defined by the ACTION_STATE_FIND_PATTERN. Both absolute and relative paths are supported.

- **ACTION_STATE_FIND_PATTERN**: (optional) defaults to `*.sls`

- **ACTION_STATE_FIND_TYPE**: (optional) used as parameter for find, defaults to `name`

- **SALT_LINT_EXTRA_PARAMS**: (optional) extra parameters passed to the salt-lint command, e.g. `-v` for increased verbosity. Check `salt-lint` help for more information.

## License

The Dockerfile and associated scripts and documentation in this project are released under the [MIT](license).

## Credits

The GitHub action is heavily based on [ansible-lint-action](https://github.com/ansible/ansible-lint-action). The initial [ansible-lint-action](https://github.com/ansible/ansible-lint-action) has been created by [Stefan Stölzle](/stoe) at [stoe/actions](https://github.com/stoe/actions).