crystal-ameba / github-action Goto Github PK

When installing this action as described in the readme
it unfortunately builds very slowly:

This seems to be caused by the --release flag that was added in #14.
Having a 5 minute wait in every CI run is not nice and can lead to early exhaustion
of the free build minutes quota.

So I would like to suggest let's revert #14?

The linting error ameba reported locally: [C] Layout/TrailingWhitespace: Trailing whitespace detected

Unhandled exception: Response: Unprocessable Entity. Body: {"message":"Invalid request.\n\nFor 'properties/raw_details', nil is not a string.","documentation_url":"https://developer.github.com/v3/checks/runs/#update-a-check-run"} (Exception)
from ../../app/src/ameba-github_action/github_client.cr:22:7 in 'handle_response'
from ../../app/src/ameba-github_action/github_client.cr:18:7 in 'patch'
from ../../app/src/ameba-github_action/runner.cr:62:7 in 'update_check'
from ../../app/src/ameba-github_action/runner.cr:20:9 in 'run'
from ../../app/src/ameba-github_action.cr:4:1 in '__crystal_main'
from ../../usr/share/crystal/src/crystal/main.cr:105:5 in 'main_user_code'
from ../../usr/share/crystal/src/crystal/main.cr:91:7 in 'main'
from ../../usr/share/crystal/src/crystal/main.cr:114:3 in 'main'
from __libc_start_main
from _start
from ???

From the README.md:

Build the docker image:

docker build . -t crystal-ameba/github-action
Run it:

docker run -it crystal-ameba/github-action

But it fails with stack trace:

Unhandled exception: Missing ENV key: "GITHUB_WORKSPACE" (KeyError)
  from /usr/share/crystal/src/env.cr:53:7 in 'fetch'
  from /usr/share/crystal/src/env.cr:22:5 in '[]'
  from src/ameba-github_action/runner.cr:8:20 in 'initialize'
  from src/ameba-github_action/runner.cr:7:5 in 'new'
  from src/ameba-github_action.cr:4:1 in '__crystal_main'
  from /usr/share/crystal/src/crystal/main.cr:110:5 in 'main_user_code'
  from /usr/share/crystal/src/crystal/main.cr:96:7 in 'main'
  from /usr/share/crystal/src/crystal/main.cr:119:3 in 'main'
  from __libc_start_main
  from _start
  from ???

Any way to run this locally ? I'm contributing to closed source project written in Crystal and using this action in GitHub on pull request, it passed the checks while running ameba locally as dependency, it failed (on purpose introduced fail):

[W] Lint/UselessAssign: Useless assignment to variable `p`
> p = 3
  ^

Finished in 8.93 seconds
30 inspected, 1 failure

EDIT:

Also, this is ameba jobs in our workflow:

# AMEBA
  ameba-test:
    runs-on: ubuntu-latest
    container:
      image: crystallang/crystal:1.0.0
    steps:
      - name: Checkout
        uses: actions/checkout@v1
      - name: Crystal Ameba Linter
        id: crystal-ameba
        uses: crystal-ameba/[email protected]
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Seems like # ameba:disable comments in code have no effect when ameba is being run as an GitHub Action. running via bin/ameba reports 0 warnings.

Clicking on Check warning on line ... link leads to /commit/<commit-sha>#annotation_<id>, where there's neither the request file nor annotation nowhere to be found.

Action must be reworked to not be dependent on a specific Ameba version. We need to use Ameba dependency used by the project that installs the action and catch reported issues over json formatter, for example.

That way we will not need to bump a new release for action each time we release the Ameba

https://github.com/cloudamqp/amqproxy/runs/2240784848?check_suite_focus=true

Unhandled exception: Arithmetic overflow (OverflowError)
  from /usr/share/crystal/src/json/any.cr:167:18 in 'as_i'
  from /app/src/ameba-github_action/runner.cr:36:7 in 'create_check'
  from /app/src/ameba-github_action/runner.cr:17:7 in 'run'
  from /app/src/ameba-github_action.cr:4:1 in '__crystal_main'
  from /usr/share/crystal/src/crystal/main.cr:110:5 in 'main_user_code'
  from /usr/share/crystal/src/crystal/main.cr:96:7 in 'main'
  from /usr/share/crystal/src/crystal/main.cr:119:3 in 'main'
  from __libc_start_main
  from _start
  from ???

Notice that it's using crystal 1.4.1 still?
However I can see that it's 1.6.0 in your latest release

hence it's failing with

Not as bad as #16 but it still takes over 2 minutes to compile the binary, repeated on each and every action 😞 while running Ameba itself will run in 1 second.

Couldn't the action download a precompiled binary? It could be attached to the releases for example. The action would then only take a few seconds to run.

When running the github action, it lints my dependencies too (see https://github.com/MatheusRich/dontfile.cr/runs/598372786?check_suite_focus=true). Running locally this do not happen.

Is this expected? Should I add a .ameba.yml config to avoid this?