camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
37 stars 60 forks source link

Megalinter initial #207

Closed RandyLevensalor closed 10 months ago

RandyLevensalor commented 10 months ago

What type of PR is this?

Add one of the following kinds:

What this PR does / why we need it:

This adds megalinter github action to lint yaml files and provide some basic repository checks.

This checks against the openapi configuration with a few example rules based on commonalities.

Whitespace changes were made to the yaml files to pass the yaml linting.

A couple of minor changes were made to ensure compliance with the open api schema.

Which issue(s) this PR fixes:

Fixes #158

Special notes for reviewers:

The yamllint and openapirc configuration files are in the root of the repository. These could be moved to another directory.

JAVA and MARKDOWN linters, which are a part of megalinter are currently disabled. Enabling these will require additional changes to their respective formats and possible updates to the linting.

Changelog input

 release-note

Added megalinter github action to check the formatting of yaml files.

Additional documentation

This section can be blank.

docs