Crystal Ameba GitHub Action

January 14, 2026 · View on GitHub

GitHub Action that lints Crystal code with Ameba linter.

Inputs

Warning

Available only for the master branch.

Input nameDescriptionRequired?Default value
configPath to the configuration file✗—
versionVersion of Ameba ruleset to check against✗—
min-severityMinimum severity of issues to report✗convention
onlyRun only given rules (or groups)✗—
exceptDisable 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 versionGitHub Action version
mastermaster
~> v1.6.4v0.12.0
~> v1.6.3v0.11.0
~> v1.6.2v0.10.0
~> v1.6.1v0.9.0
~> v1.5.0v0.8.0
~> v1.4.0v0.7.1
v1.3.1v0.6.0
v1.2.0v0.5.1
v1.1.0v0.4.0
v1.0.1v0.3.1
v1.0.0v0.3.0
v0.14.3v0.2.12

Bump versions

  • Crystal version should be updated in Dockerfile file (version of the image).

Contributing

  1. Fork it (https://github.com/crystal-ameba/github-action/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors