task: add ipa validation to run during CI/CD process

[wtrocki]

Proposed changes

IPA validation needs to run during PR process to verify if:

• IPA rule were not made error by mistake and covers existing API
• package bump does not break spectral ruleset

PR should be never merged with failed spectral validation as it will affect and break downstream builds.

Testing

Run echo "Ensuring no error violations available in OpenAPI"
Ensuring no error violations available in OpenAPI

ipa-validation
spectral lint ./openapi/v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml

No results with a severity of 'error' found!

spectral-validation
spectral lint ./openapi/v2.yaml --ruleset=./tools/spectral/.spectral.yaml

No results with a severity of 'error' found!

[wtrocki]

That does not run our "classic" spectral rules. Ideally we might want to run both?

[wtrocki]

Done

[yelizhenden-mdb]

How does it differentiate if there are validation failures or some other error happening?

[lovisaberggren]

Are these not already running on PRs? Reference: https://github.com/mongodb/openapi/blob/main/.github/workflows/spectral-lint.yml

[wtrocki]

@lovisaberggren Good catch. I will adjust that job to run on javascript files and package.json bumps (when spectral is bumped)

@yelizhenden-mdb Error message will be different. Validation failure vs Spectral failure (which is unlikely since we try catch logic in each rule at the moment).

[lovisaberggren]

Cool, yeah that's why it didn't run in a few cases 👍

[lovisaberggren]

Thanks!