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

[DDO-2918] Remove uncalled v1 code; add API diff checker action #191

Merged
merged 15 commits into from Jun 21, 2023

Conversation

jack-r-warren
Copy link
Member

@jack-r-warren jack-r-warren commented Jun 21, 2023

  • Removes a bunch of v1 code that isn't executed anymore
    • Note that I'm not changing Sherlock's package structure here, because that would end up being a breaking change in client libraries (though not the API itself)
  • Adds an API diff checker action that'll comment any impacts to the Swagger spec in the PR
    • It won't have permission to comment when it runs as dependabot, so it'll just fail then, since dependabot PRs shouldn't change the API
  • Fixes some dependencies that got broken by an earlier dependabot PR. Not broken enough that the code actually had any problems, but bad enough that the linter had this issue. Fix was just running go mod tidy but I added that to the build action so it'll run that automatically now.

Testing

I added the API diff checker here to help test that Sherlock's external API that clients rely on is unchanged. Combined with the remaining tests passing I think we're set.

Risk

Doesn't remove v1 tables still, so can revert if there's an issue.

@github-actions
Copy link

github-actions bot commented Jun 21, 2023

No API changes detected

@codecov
Copy link

codecov bot commented Jun 21, 2023

Codecov Report

Patch coverage has no change and project coverage change: -2.14 ⚠️

Comparison is base (34a37ea) 53.55% compared to head (5df768c) 51.41%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #191      +/-   ##
==========================================
- Coverage   53.55%   51.41%   -2.14%     
==========================================
  Files          66       52      -14     
  Lines        5445     4913     -532     
==========================================
- Hits         2916     2526     -390     
+ Misses       2389     2257     -132     
+ Partials      140      130      -10     
Impacted Files Coverage Δ
sherlock/internal/db/connect.go 0.00% <ø> (ø)
sherlock/internal/db/test_helpers.go 0.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@github-actions
Copy link

github-actions bot commented Jun 21, 2023

Published image from 5df768c (merge 52815ed):

us-central1-docker.pkg.dev/dsp-artifact-registry/sherlock/sherlock:v0.1.66-52815ed

@sonarcloud
Copy link

sonarcloud bot commented Jun 21, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@jack-r-warren jack-r-warren marked this pull request as ready for review June 21, 2023 19:45
@jack-r-warren jack-r-warren requested a review from a team as a code owner June 21, 2023 19:45
@jack-r-warren jack-r-warren added this pull request to the merge queue Jun 21, 2023
Merged via the queue into main with commit a9f01fa Jun 21, 2023
10 checks passed
@jack-r-warren jack-r-warren deleted the DDO-2918-remove-v1 branch June 21, 2023 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants