adobe / da-admin

Apache License 2.0
0 stars 4 forks source link

GH-6 Version Labels #38

Closed bosschaert closed 3 months ago

bosschaert commented 4 months ago

Description

Make it possible to provide a version display name on the initial version POST/PUT.

Related Issue

6

How Has This Been Tested?

Types of changes

Checklist:

Release notes

  1. Ability to add a label to a version upon creation.

Additional context

Version labels provide a humane context to what a version represents. They can also be helpful for larger larger content projects. Changes happen over a series of days, weeks, or even months. This disjointed nature of content creation makes snapshot-style versions difficult to impossible to use. Being able to label versions provides a way to say in human terms, "rollback to a pre-Adobe MAX 2024 state."

DA Admin is built on top of object storage technologies. This provides a no-nonsense approach to data storage, but it lacks the granular nature of something like a NoSQL database. Object storage metadata is also immutable. What this effectively means is that if you want to update metadata, you must re-write the entire file. Moving version label creation to the POST handler ensures that we can perform one operation to create the version and label.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.56%. Comparing base (8eabefd) to head (fd8357d).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #38 +/- ## ========================================== + Coverage 77.03% 79.56% +2.52% ========================================== Files 14 14 Lines 897 915 +18 ========================================== + Hits 691 728 +37 + Misses 206 187 -19 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

bosschaert commented 3 months ago

Thanks @auniverseaway I agree label is better so I changed it to that and also added comment.

auniverseaway commented 3 months ago

@bosschaert I approved, but I would remove the comment part. I wouldn't build that out until someone asks for it. Label should do for the foreseeable future and we can always add comment back in later.