camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
9 stars 24 forks source link

Linting test definitions #142

Open rartych opened 5 months ago

rartych commented 5 months ago

Problem description API definitions linting rules use Megalinter tool to configure workflows in Github. It would be good to perform lint check also on test definitions that are mandatory work product of subprojects.

Possible evolution For API test definitions (Gherkin files) gherkin-lint tool can be used with Megalinter: https://megalinter.io/latest/descriptors/gherkin_gherkin_lint/ gherkin-lint can be easily added to the current Megalinter workflow.

Alternative solution Other tools for linting Gherkin files with dedicated Github Actions.

Additional context It needs to be investigated if specific rules can check the recommendations in API Testing Guidelines