Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewmcodes/haml-lint-action
A GitHub Action that lints your HAML code with HAML Lint!
https://github.com/andrewmcodes/haml-lint-action
action actions andrewmcodes annotations github-actions haml haml-action haml-lint haml-lint-action haml-linter-action lint linter ruby ruby-on-rails workflow
Last synced: 16 days ago
JSON representation
A GitHub Action that lints your HAML code with HAML Lint!
- Host: GitHub
- URL: https://github.com/andrewmcodes/haml-lint-action
- Owner: andrewmcodes
- License: mit
- Created: 2019-11-07T23:17:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T06:36:13.000Z (almost 2 years ago)
- Last Synced: 2024-11-29T14:55:26.428Z (23 days ago)
- Topics: action, actions, andrewmcodes, annotations, github-actions, haml, haml-action, haml-lint, haml-lint-action, haml-linter-action, lint, linter, ruby, ruby-on-rails, workflow
- Language: Ruby
- Homepage:
- Size: 204 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.repostatus.org/#inactive)
# :white_check_mark: HAML Lint Action
A GitHub Action to run [HAML-Lint](https://github.com/sds/haml-lint) against your code and create annotations in the GitHub UI.
## :page_facing_up: Introduction
GitHub Actions are an amazing new tool that can dramatically improve productivity while using the GitHub platform. While it is not hard to write a custom GitHub action to run HAML-Lint on your codebase, this action takes that functionality one step further using the checks API. After the HAML Lint Action runs HAML-Lint against your code, it will create annotations that you can easily view, matched up with the offending code.
Since GitHub actions and the checks API are continually changing, it is possible that there will be breaking API changes that affect this action. If so, please open an issue and I will look into it as soon as I can.
## :bulb: Usage
Add the following to your GitHub action workflow to use HAML Lint Action:
```yaml
- name: HAML Lint
uses: andrewmcodes/[email protected]
with:
file_paths: 'app/**/*.html.haml'
fail_level: 'error'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
It is **highly** recommend you tie yourself to a version and do not do the following.
I promise your life will be much easier. 😇
```yml
# ❌ Danger, sometimes I break things!
uses: andrewmcodes/haml-lint-action@master
# ✅ Much better.
uses: andrewmcodes/[email protected]
```
### :package: Example Workflow
Here is an example workflow file incorporating HAML Lint Action:
```yaml
name: HAML Lint
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: HAML Lint
uses: andrewmcodes/[email protected]
with:
file_paths: 'app/**/*.html.haml'
fail_level: 'error'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
**Go [here](https://github.com/andrewmcodes/haml-lint-action-playground/blob/master/.github/workflows/test.yml) to see more examples!**
### :moneybag: Available Inputs
Refer to the [official `haml-lint` documentation](https://github.com/sds/haml-lint#usage) for more information on the `haml-lint` options.
| **Input Parm Name** | **Required** | **Default Value** | **`haml-lint` option** | **Description** | **Example** |
| :-----------------: | :----------: | :---------------: | :--------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------: |
| bundle | false | false | no | If you want to use a version of a gem you maintain this is your best bet. **NOTE:** action run time will increase relative to the size of your Gemfile. | `true` |
| file_paths | false | `app/views/` | yes | Define the paths you wish to be linted per run. Multiple paths can be on one line by adding a space. | `'app/**/*.html.haml'` |
| version | false | _latest release_ | no | Define a specific version of the `haml-lint` gem. | `'0.33.0'` |
| additional_gems | false | | no | Additional Gems can be installed via one line with spaces and commands are supported like a version. | `'rubocop-rails rubocop-performance'` |
| config_path | false | | yes | By default, `haml-lint` will load any file with the name `.haml-lint.yml` as a configuration file. If you want to load a config file with a different name or path, specify the path. | `'config/haml-lint.yml'` |
| exclude_paths | false | | yes | Define a list of paths to exclude from being linted. | `'app/views/home/*.html.haml'` |
| fail_level | false | `error` | yes | Can define `error` or `warning` to cause haml-lint to error out on. | `'warning'` |
## :warning: Gotchas
1. Due to the GitHub Check Runs API, we can only return 50 annotations per run. See [here](https://developer.github.com/v3/checks/runs/#output-object) for more info.
2. There is a bug with the Checks API that might cause your runs to get jumbled in the UI, but they will all still run and render annotations in the diff correctly.
3. You can't use --version with multiple gems. You can specify multiple gems with version requirements using `gem install 'my_gem:1.0.0' 'my_other_gem:~>2.0.0'`
## :camera_flash: Screenshots
## :bookmark: Changelog
[View our Changelog](/CHANGELOG.md)
## :sos: Contributing
[Contributing Guide](/CONTRIBUTING.md)
## :rotating_light: Code of Conduct
[Code of Conduct](/CODE_OF_CONDUCT.md)
## :copyright: License
[MIT](/LICENSE.md)
## :robot: Check Out My Other Ruby GitHub Actions
- [andrewmcodes/rubocop-linter-action](https://github.com/andrewmcodes/rubocop-linter-action).
- [andrewmcodes/standardrb-action](https://github.com/andrewmcodes/standardrb-action).
## ✨ Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Andrew Mason
🚇 📖 💻
Christopher Pezza
💻 📖 🚇 👀
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!