kimburgess / github-action

A GitHub Action that lints Crystal shards with Ameba

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/[email protected]
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Example Workflow

name: Crystal CI

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    container:
      image: crystallang/crystal

    steps:
    - uses: actions/checkout@v1
    - name: Crystal Ameba Linter
      id: crystal-ameba
      uses: crystal-ameba/[email protected]
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Install dependencies
      run: shards install
    - name: Run tests
      run: crystal spec

Compatibility Versions

Ameba version	GitHub Action version
v0.14.3	v0.2.12
v0.14.2	v0.2.11
v0.14.1	v0.2.9
v0.13.4	v0.2.8
v0.13.3	v0.2.7
v0.13.2	v0.2.6
v0.13.1	v0.2.5
v0.13.0	v0.2.4
v0.12.1	v0.2.3
v0.12.0	v0.2.2
v0.11.0	v0.2.1
v0.10.1	v0.1.1

Development

Build the docker image:

docker build . -t crystal-ameba/github-action

Run it:

docker run -it crystal-ameba/github-action

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