-
Notifications
You must be signed in to change notification settings - Fork 11.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CI: Add Drone pipeline to check that Alerting Swagger API spec is up to date #71244
Closed
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
46df27f
to
bca7de7
Compare
bca7de7
to
c9bb703
Compare
This is blocked by go-swagger/go-swagger#2783, closing for now. Several paths forward exist:
|
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area/alerting
Grafana Alerting
area/backend
no-backport
Skip backport of PR
no-changelog
Skip including change in changelog/release notes
type/ci
Tasks related to Continuous Integration workflow
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.
What is this feature?
This PR introduces a new Drone pipeline that will verify the Swagger spec for Alerting is up to date with the definitions and fail CI if this isn't the case. This should be easy to extend to cover all Swagger definitions later as well.
Why do we need this feature?
Currently a developer needs to be sure to run the relevant
make
command whenever they make changes to a Swagger definition in Alerting. This can lead to the spec drifting from the definitions.Who is this feature for?
Users of the Alerting Swagger docs.
Which issue(s) does this PR fix?:
/
Special notes for your reviewer:
Please check that: