Spike repo for testing actions and workflows for validating OpenAPI schema versions

The action uses a containerized version of openapitools/openapi-diff

Possible alternative to the diff lib could be tufin/oasdiff

Install Act to work on the action locally:

brew install act

If using act to dev the action locally run the command below:

act pull_request -e /act_data/pull_request.json -s GITHUB_TOKEN=[TOKEN] --privileged --bind

or if you are using env and secret files.

act pull_request -e /act_data/pull_request.json --env-file ${HOME}/.config/act/.env --secret-file ${HOME}/.config/act/vault.env --privileged --bind

Running act currently pollutes the repo root with the following directories and files but are ignored in .gitignore:

_actions
base
head
workflow
results

This repo contains a ruby script that can be used to generate a change set between two sets of OpenAPI schemas. There are example diff set schemas checked into this repo as well. Generate changesets by running the following command from the root.

ruby ./.github/workflows/generate_changeset.rb $PWD/schemas/base/descriptions $PWD/schemas/head/descriptions