Crystal Ameba GitHub Action

GitHub Action that lints Crystal shards with Ameba linter

Usage

Add the following to your GitHub action workflow to use Crystal Ameba Linter:

- name: Crystal Ameba Linter
  uses: crystal-ameba/github-action@v0.11.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Example Workflow

name: Crystal CI

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Install Crystal
        uses: crystal-lang/install-crystal@v1

      - name: Download source
        uses: actions/checkout@v4

      - name: Install dependencies
        run: shards install

      - name: Run tests
        run: crystal spec

      - name: Run Ameba Linter
        uses: crystal-ameba/github-action@v0.10.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Compatibility Versions

Ameba version	GitHub Action version
~> v1.6.3	v0.11.0
~> v1.6.2	v0.10.0
~> v1.6.1	v0.9.0
~> v1.5.0	v0.8.0
~> v1.4.0	v0.7.1
v1.3.1	v0.6.0
v1.2.0	v0.5.1
v1.1.0	v0.4.0
v1.0.1	v0.3.1
v1.0.0	v0.3.0
v0.14.3	v0.2.12

Bump versions

• Crystal version should be updated in Dockerfile file (version of the image).
• Ameba version should be updated in shard.yml/shard.lock files.

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

• Vitalii Elenhaupt - creator and maintainer
• Sijawusz Pur Rahnama - contributor and maintainer