Feat: add --check option in Mix tasks to compare the generated spec with a previously generated file
#618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a --check option to run Mix tasks and compare the generated spec with a previously generated file. This is useful for scenarios where a CI check is desirable to catch unwanted drifts from a validated OpenAPI spec: e.g. the OpenAPI spec is committed and reviewed, and should not change without additional review. Fixes open-api-spex#617 Signed-off-by: Davide Briani <davide@briani.dev>
mbuhot
approved these changes
Jul 7, 2024
zachdaniel
reviewed
Jul 8, 2024
| @@ -7,6 +7,7 @@ defmodule Mix.Tasks.Openapi.Spec.Json do | |||
|
|
|||
| $ mix openapi.spec.json --spec PhoenixAppWeb.ApiSpec apispec.json | |||
| $ mix openapi.spec.json --spec PhoenixAppWeb.ApiSpec --pretty=true | |||
| $ mix openapi.spec.json --spec PhoenixAppWeb.ApiSpec --check=true | |||
There was a problem hiding this comment.
Small stylistic note: Boolean arga can be set to true with just --arg, looks a bit nicer than --arg=true
nathanalderson
pushed a commit
to Tango-Tango/open_api_spex
that referenced
this pull request
Dec 20, 2024
…le (open-api-spex#618) Add a --check option to run Mix tasks and compare the generated spec with a previously generated file. This is useful for scenarios where a CI check is desirable to catch unwanted drifts from a validated OpenAPI spec: e.g. the OpenAPI spec is committed and reviewed, and should not change without additional review. Fixes open-api-spex#617 Signed-off-by: Davide Briani <davide@briani.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a
--checkoption to run Mix tasks and compare the generated spec with a previously generated file.This is useful for scenarios where a CI check is desirable to catch unwanted drifts from a validated OpenAPI spec: e.g. the OpenAPI spec is committed and reviewed, and should not change without additional review.
Fixes #617