Codeclimate

[Blaimi]

PR summary

This PR adds the compatibility to run as CodeClimate Engine.

Closes: #512

Todo

• write unit tests
• test in gitlab infrastructure (biletado/apidocs!1) The findings are listed like it is documented for the Premium tier (but they are not shown in the "Changes" like they should because the project has an OSS ultimate license :/) needs a run on the target branch
• register this or another project for the opensource program at codeclimate and test the integrations on their infrastructure as well as github integration
• implement include_paths
• create a docker container with
  • FROM jamescooke/openapi-validator:$version
  • WORKDIR /code
  • ENTRYPOINT ["lint-openapi", "--config", "/config.json", "--codeclimate"]
  • see the more complex Containerfile
• get in touch with Code Climate and publish as community engine
• If files cannot be parsed, the validator exits with a non-zero code which crashes the whole execution.

PR Checklist

General checklist

Please make sure that your PR fulfills the following requirements:

• The commit message follows the Angular Commit Message Guidelines.
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Dependencies have been updated as needed
• .secrets.baseline updated as needed?

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[dpopp07]

Is this necessary for the code climate support?

[Blaimi]

Not at all, but a config.json passed by codeclimate file looks like this:

{
  "enabled":true,
  "channel":"stable",
  "include_paths": [
    ".gitignore",
    "public/",
    ".gitattributes",
    "LICENSE",
    ".gitlab-ci.yml",
    "Dockerfile",
    "docker-entrypoint.d/",
    ".codeclimate.yml"
  ],
  "debug":"1"
}

when executing in biletado/apidocs.

One can still add a files section in .codeclimate.yml like I do at the moment for testing until the implementation for the recursive filesearch is implemented. This is then added to the config.json. You can have a look at the .codeclimate.yml I used in the mentioned project for testing this as an engine.

[Blaimi]

gitlab integration looks nice :)

https://gitlab.com/biletado/apidocs/-/merge_requests/1/diffs#416b6ad6e0af19ad0cea28667e2544b23b326dbd