GithubHelp home page GithubHelp logo

kimburgess / github-action Goto Github PK

View Code? Open in Web Editor NEW

This project forked from crystal-ameba/github-action

0.0 1.0 0.0 262 KB

A GitHub Action that lints Crystal shards with Ameba

License: MIT License

Dockerfile 3.33% Crystal 96.67%

github-action's Introduction

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

github-action's People

Contributors

matheusrich avatar veelenga avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.