https://github.com/alejandrosuero/selene-linter-action
GitHub action for selene lua linter
https://github.com/alejandrosuero/selene-linter-action
Last synced: 6 months ago
JSON representation
GitHub action for selene lua linter
- Host: GitHub
- URL: https://github.com/alejandrosuero/selene-linter-action
- Owner: AlejandroSuero
- License: mit
- Created: 2024-05-07T08:07:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T18:15:03.000Z (8 months ago)
- Last Synced: 2024-10-22T09:34:18.870Z (8 months ago)
- Language: TypeScript
- Size: 1.13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
GitHub Action for Selene
GitHub action to run [selene](https://github.com/Kampfkarren/selene), a
blazing-fast modern Lua linter written in Rust.
## Usage
```yaml
- 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](./LICENSE)
## Inspiration
- [selene-action](https://github.com/NTBBloodbath/selene-action)
> [!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](https://github.com/AlejandroSuero/selene-linter-action/fork) this
project.
2. Clone your fork (`git clone `).
3. Add main repo as remote (`git remote add upstream `).
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 `).
7. Open a [PR](https://github.com/AlejandroSuero/selene-linter-action/pulls).
For more information, check [CONTRIBUTING.md](./CONTRIBUTING.md)