Skip to content
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
wants to merge 19 commits into from

Conversation

rwwiv
Copy link
Contributor

@rwwiv rwwiv commented Jul 7, 2023

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:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

@rwwiv rwwiv requested a review from a team July 7, 2023 19:52
@grafanabot grafanabot added the type/ci Tasks related to Continuous Integration workflow label Jul 7, 2023
@rwwiv rwwiv requested review from a team, armandgrillet, JacobsonMT, yuri-tceretian and grobinson-grafana and removed request for a team July 7, 2023 19:53
@rwwiv rwwiv added the area/alerting Grafana Alerting label Jul 7, 2023
@rwwiv rwwiv added no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Jul 10, 2023
@rwwiv rwwiv added this to the 10.0.x milestone Jul 10, 2023
@rwwiv rwwiv requested a review from a team as a code owner July 10, 2023 16:41
@rwwiv rwwiv requested review from sakjur, papagian and yangkb09 and removed request for a team July 10, 2023 16:41
@rwwiv rwwiv force-pushed the rwwiv/swagger-ci-check branch 2 times, most recently from 46df27f to bca7de7 Compare July 11, 2023 18:08
@rwwiv
Copy link
Contributor Author

rwwiv commented Jul 17, 2023

This is blocked by go-swagger/go-swagger#2783, closing for now.

Several paths forward exist:

  1. Fix the bug above.
  2. Use adapters between our models and external structs.

@rwwiv rwwiv closed this Jul 17, 2023
@zerok zerok modified the milestones: 10.0.x, 10.0.3, 10.1.x Jul 18, 2023
@ricky-undeadcoders ricky-undeadcoders modified the milestones: 10.1.x, 10.1.0 Aug 1, 2023
@zerok zerok removed this from the 10.1.0 milestone Aug 2, 2023
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants