Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 1.84 KB

README.md

File metadata and controls

70 lines (50 loc) · 1.84 KB
Raw

GitHub Action for Selene

selene-linter-action status

GitHub action to run selene, a blazing-fast modern Lua linter written in Rust.

Usage

- uses: actions/checkout@v4
- uses: AlejandroSuero/[email protected]
  with:
    # Github secret token
    token: ${{ secrets.GITHUB_TOKEN }}
    # selene arguments
    args: --display-style=quiet .
    # selene version
    version: 0.27.1

Parameters

Required parameters

  • token
    • GitHub secret token for downloading selene binary from GitHub releases.
  • args
    • Arguments to be passed to selene.

Optional parameters

  • version
    • Version of selene to be used. If not specified, installs the latest release.

License

selene-action is MIT licensed

Inspiration

Note

It has been +3 years since last updated

Contributing

Thank you to everyone that is contributing and to those who want to contribute. Any contribution is welcomed!

Quick guide:

  1. Fork this project.
  2. Clone your fork (git clone <fork-URL>).
  3. Add main repo as remote (git remote add upstream <main-repo-URL>).
  4. Create a branch for your changes (git switch -c feature/your-feature or git switch -c fix/your-fix).
  5. Commit your changes (git commit -m "feat(...): ...").
  6. Push to your fork (git push origin <branch-name>).
  7. Open a PR.

For more information, check CONTRIBUTING.md