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-3208] Record authors upon v3 version creation #325

Merged
merged 3 commits into from
Oct 10, 2023

Conversation

jack-r-warren
Copy link
Contributor

As @katiewelch rolls out #321 and #306, we'll begin ingesting version authorship.

This will be helpful for making deploy notifications that can @ the specific folks who authored versions in the deployment.

Testing

Full coverage (including different creation mechanisms, ensuring that the pre-create hooks work)

Risk

Very low. Will need to disable the prepared statement cache before deployment so the database migration will run smoothly.

@jack-r-warren jack-r-warren requested a review from a team as a code owner October 10, 2023 18:53
@github-actions
Copy link

What's Changed


GET /api/app-versions/v3
Parameters:

Added: authoredBy in query

Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    Changed items (object):

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

      • Property createdAt (string)

      • Property email (string)

      • Property githubID (string)

      • Property githubUsername (string)

      • Property googleID (string)

      • Property id (integer)

      • Property name (string)

      • Property nameFrom (string)

        Enum values:

        • sherlock
        • github
        • slack
      • Property nameInferredFromGithub (boolean)

        Controls whether Sherlock should automatically update the user's name based on a connected GitHub identity.
        Will be set to true if the user account has no name and a GitHub account is linked.

      • Property slackID (string)

      • Property slackUsername (string)

      • Property suitabilityDescription (string)

        Available only in responses; describes the user's production-suitability

      • Property suitable (boolean)

        Available only in responses; indicates whether the user is production-suitable

      • Property updatedAt (string)

GET /api/app-versions/v3/{selector}
Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

PATCH /api/app-versions/v3/{selector}
Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

POST /api/appVersions/v3
Return Type:

Changed response : 201 Created

Created

  • Changed content type : application/json

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

GET /api/chart-versions/v3
Parameters:

Added: authoredBy in query

Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    Changed items (object):

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

GET /api/chart-versions/v3/{selector}
Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

PATCH /api/chart-versions/v3/{selector}
Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

POST /api/chartVersions/v3
Return Type:

Changed response : 201 Created

Created

  • Changed content type : application/json

    • Added property authoredBy (string)

    • Added property authoredByInfo (object)

GET /api/app-versions/procedures/v3/changelog
Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property changelog (array)

      Changed items (object):

      • Added property authoredBy (string)

      • Added property authoredByInfo (object)

GET /api/chart-versions/procedures/v3/changelog
Return Type:

Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property changelog (array)

      Changed items (object):

      • Added property authoredBy (string)

      • Added property authoredByInfo (object)

@github-actions
Copy link

github-actions bot commented Oct 10, 2023

Published image from f3eeb9c (merge e39e949):

us-central1-docker.pkg.dev/dsp-artifact-registry/sherlock/sherlock:v0.2.10-e39e949

@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

Merging #325 (f3eeb9c) into main (04bb47e) will increase coverage by 0.11%.
The diff coverage is 81.25%.

@@            Coverage Diff             @@
##             main     #325      +/-   ##
==========================================
+ Coverage   63.11%   63.23%   +0.11%     
==========================================
  Files         147      147              
  Lines        8611     8671      +60     
==========================================
+ Hits         5435     5483      +48     
- Misses       2807     2813       +6     
- Partials      369      375       +6     
Files Coverage Δ
sherlock/internal/models/app_version.go 93.75% <100.00%> (+0.76%) ⬆️
sherlock/internal/models/chart_version.go 93.75% <100.00%> (+0.76%) ⬆️
sherlock/internal/api/sherlock/app_version_v3.go 70.83% <73.91%> (+0.97%) ⬆️
sherlock/internal/api/sherlock/chart_version_v3.go 71.73% <73.91%> (+0.72%) ⬆️

@sonarqubecloud
Copy link

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 2 Code Smells

No Coverage information No Coverage information
2.7% 2.7% Duplication

@jack-r-warren jack-r-warren merged commit e3a8906 into main Oct 10, 2023
11 checks passed
@jack-r-warren jack-r-warren deleted the DDO-3208-record-author branch October 10, 2023 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants