Modularize the OAS actions/workflows

[sergei-maertens]

So, reason for these changes is that we essentially have some interesting snippets that would benefit from being centralized, while still allowing flexibility. Personally, I want to stop maintaining repeated CI code in https://github.com/GPP-Woo/gpp-zoeken and https://github.com/GPP-Woo/gpp-publicatiebank, but also in https://github.com/open-formulieren/open-forms which also publishes its API checks and performs this kind of quality control on them.

I've tried to do this in a way that should not be too invasive and still offer great flexibility.

My design constraints I've taken into account are

• a single place where the used tools are known/managed (with tools like spectral, drf-spectacular, openapi-generator...)
• use the same pattern, but allow customizing details to fit the project that's using it
• support split and monorepo's - if the backend lives in the backend directory, that should still work (currently untested)
• make it easy to do the common stuff without having to worry about it, while providing escape hatches otherwise
• have efficient CI pipelines and use of the runners

The approach I've taken for this is

• what are now separate jobs in most of my projects and even separate workflows in team bron projects (the existing workflows in this repo) become composite actions
• the OAS generation should only happen once and stored in an artifact that can be re-used
• each action is documented and has its input parameters defined
• there's a single workflow that uses these actions so you can easily run a battle-tested setup. if you want to tinker around with dependencies/order of operations, you can create your own workflow in your project based on the composite actions

Validation

I'm running these actions and/or workflows in several projects to verify that this setup works for (almost) everyone. Below the status of each project:

• ✅ - GPP-Woo/gpp-zoeken
• ✅ - open-formulieren/open-forms
• maykinmedia/open-archiefbeheer monorepo, but they don't seem to publish their OAS
• ✅ - open-zaak/open-zaak
• ✅ - maykinmedia/objects-api & objecttypes-api
• ✅ - maykinmedia/open-klant

[stevenbal]

@sergei-maertens the approach looks good to me, I think it's nice to have the workflow that combines them all 👍

[stevenbal]

Thanks for this 🎉