GH-6 Version Labels

[bosschaert]

Description

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

Related Issue

#6

How Has This Been Tested?

• Tested locally with da-collab and da-live
• Unit tests for all changes

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

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]

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[auniverseaway]

I think AEM is right here and would probably lean towards building something familiar...

I would say, label instead of displayname. This is how we would expose it in the UI.

[bosschaert]

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

[auniverseaway]

@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.