README
Crystal Ameba GitHub Action
GitHub Action that lints Crystal code with Ameba linter.
Inputs
[!WARNING] Available only for the
masterbranch.
| Input name | Description | Required? | Default value |
|---|---|---|---|
config | Path to the configuration file | ✗ | — |
version | Version of Ameba ruleset to check against | ✗ | — |
min-severity | Minimum severity of issues to report | ✗ | convention |
only | Run only given rules (or groups) | ✗ | — |
except | Disable the given rules (or groups) | ✗ | — |
Usage
To use Crystal Ameba Linter, add the following step to your GitHub action workflow:
+ - name: Run Ameba Linter
+ uses: crystal-ameba/github-action@master
Example Workflow
name: Ameba
on:
push:
pull_request:
permissions:
contents: read
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Download source
uses: actions/checkout@v6
- name: Run Ameba Linter
uses: crystal-ameba/github-action@master
Compatibility Versions
| Ameba version | GitHub Action version |
|---|---|
| master | master |
| ~> 1.6.4 | 0.12.0 |
| ~> 1.6.3 | 0.11.0 |
| ~> 1.6.2 | 0.10.0 |
| ~> 1.6.1 | 0.9.0 |
| ~> 1.5.0 | 0.8.0 |
| ~> 1.4.0 | 0.7.1 |
| 1.3.1 | 0.6.0 |
| 1.2.0 | 0.5.1 |
| 1.1.0 | 0.4.0 |
| 1.0.1 | 0.3.1 |
| 1.0.0 | 0.3.0 |
| 0.14.3 | 0.2.12 |
Bump versions
- Crystal version should be updated in
Dockerfilefile (version of the image).
Contributing
- Fork it (https://github.com/crystal-ameba/github-action/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Contributors
- Vitalii Elenhaupt - creator and maintainer
- Sijawusz Pur Rahnama - contributor and maintainer
Contributors
Similar repos
Languages
Dockerfile
100.0%
README
Crystal Ameba GitHub Action
GitHub Action that lints Crystal code with Ameba linter.
Inputs
[!WARNING] Available only for the
masterbranch.
| Input name | Description | Required? | Default value |
|---|---|---|---|
config | Path to the configuration file | ✗ | — |
version | Version of Ameba ruleset to check against | ✗ | — |
min-severity | Minimum severity of issues to report | ✗ | convention |
only | Run only given rules (or groups) | ✗ | — |
except | Disable the given rules (or groups) | ✗ | — |
Usage
To use Crystal Ameba Linter, add the following step to your GitHub action workflow:
+ - name: Run Ameba Linter
+ uses: crystal-ameba/github-action@master
Example Workflow
name: Ameba
on:
push:
pull_request:
permissions:
contents: read
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Download source
uses: actions/checkout@v6
- name: Run Ameba Linter
uses: crystal-ameba/github-action@master
Compatibility Versions
| Ameba version | GitHub Action version |
|---|---|
| master | master |
| ~> 1.6.4 | 0.12.0 |
| ~> 1.6.3 | 0.11.0 |
| ~> 1.6.2 | 0.10.0 |
| ~> 1.6.1 | 0.9.0 |
| ~> 1.5.0 | 0.8.0 |
| ~> 1.4.0 | 0.7.1 |
| 1.3.1 | 0.6.0 |
| 1.2.0 | 0.5.1 |
| 1.1.0 | 0.4.0 |
| 1.0.1 | 0.3.1 |
| 1.0.0 | 0.3.0 |
| 0.14.3 | 0.2.12 |
Bump versions
- Crystal version should be updated in
Dockerfilefile (version of the image).
Contributing
- Fork it (https://github.com/crystal-ameba/github-action/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Contributors
- Vitalii Elenhaupt - creator and maintainer
- Sijawusz Pur Rahnama - contributor and maintainer
Similar repos
Contributors
Languages
Dockerfile
100.0%