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.

Sign up for GitHub

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

Jump to bottom

Spike to sketch out what in data per trait versioning looks like #88

Closed
Tracked by #64
SamCrooksFoundry opened this issue Apr 2, 2024 · 0 comments · May be fixed by #90
Closed
Tracked by #64

Spike to sketch out what in data per trait versioning looks like #88

SamCrooksFoundry opened this issue Apr 2, 2024 · 0 comments · May be fixed by #90
Assignees
@feltech
Labels
task

Comments

@SamCrooksFoundry
Copy link
Collaborator

SamCrooksFoundry commented Apr 2, 2024 •
edited by elliotcmorris
Loading

What

Presuming an in-data per trait versioning schema sketch out a use case involving a DCC and a manager, communicating with mixed version traits.

Why

To ensure that the interfaces are reasonable and the workflows make sense.

Tease out any further decisions that have to be made before implementation.

AC

  • Cover all methods that take trait ids/data as arguments.
  • Create an executable sketch if it's feasible/sensible
  • Both manager and host need consideration
  • Check the implications of specification have no versions.
  • Strategies for importing multiple versions of media-creation traits - in both python and cpp
  • Update Versioning generation behaviour. OpenAssetIO-TraitGen#80
@SamCrooksFoundry SamCrooksFoundry mentioned this issue Apr 2, 2024
Open
@SamCrooksFoundry SamCrooksFoundry added this to the MC v1.0.0-beta.1 milestone Apr 2, 2024
@SamCrooksFoundry SamCrooksFoundry moved this from Backlog to Todo in OpenAssetIO Development Apr 2, 2024
@feltech feltech self-assigned this Apr 10, 2024
@feltech feltech moved this from Todo to In Progress in OpenAssetIO Development Apr 10, 2024
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Examples] Trait versioning design sketch
333327c 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
@feltech feltech mentioned this issue Apr 17, 2024
Draft
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Examples] Trait versioning design sketch
84093b8 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Examples] Trait versioning design sketch
4d5e75d 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Examples] Trait versioning design sketch
92fe926 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Examples] Trait versioning design sketch
ae7b405 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Examples] Trait versioning design sketch
f3e0225 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue Apr 17, 2024
@feltech
[Docs] Trait versioning design sketch
3e22e9a 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
@elliotcmorris elliotcmorris removed this from the MC v1.0.0-beta.1 milestone Apr 19, 2024
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 15, 2024
@feltech
[Docs] Trait versioning design sketch
6d56c3a 
Closes OpenAssetIO#88. As due diligence before going ahead with an implementation,
we need to sketch out what a versioned trait package would look like,
and how hosts and managers would interact with it.

So add a contrived trait package with two versions. The "generated"
view classes have been manually created to reflect what the `traitgen`
output should be, once implemented.

These view classes are then used in a tutorial notebook that describes
how one would go about working with versioned traits.

This work may be abandoned or adapted in favour of more concrete
documentation as the feature is developed.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 15, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
e5669da 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
d3086ca 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
2eeaab0 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
932765e 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
ebfb363 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
4c74a4a 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
b3a11d9 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 16, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
578dbe3 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 17, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
caf0bd3 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal in OpenAssetIO#90, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
@feltech feltech mentioned this issue May 17, 2024
Merged
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 17, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
2e911a4 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal in OpenAssetIO#90, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 17, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
95bc073 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal in OpenAssetIO#90, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech added a commit to feltech/OpenAssetIO-MediaCreation that referenced this issue May 31, 2024
@feltech
[Docs] Add DR002 for versioning in codegen
71682e9 
Part of OpenAssetIO#88. Consolidate the discussion, provoked by iterations of the
design proposal in OpenAssetIO#90, into a decision record.

Signed-off-by: David Feltell <david.feltell@foundry.com>
@elliotcmorris elliotcmorris moved this from In Progress to Done in OpenAssetIO Development Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@feltech feltech

Labels
task
Projects
OpenAssetIO Development
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Trait versioning design sketch feltech/OpenAssetIO-MediaCreation
3 participants
@feltech @elliotcmorris @SamCrooksFoundry