Add hybrid plugin system notebook

OpenAssetIO / OpenAssetIO-MediaCreation

OpenAssetIO extensions for use in the Media Creation industry.

Apache License 2.0

12 stars 10 forks source link

Add hybrid plugin system notebook #99

Closed feltech closed 1 month ago

feltech commented 4 months ago

Add notebook for the design, documentation and e2e testing of the Hybrid Plugin System introduced in https://github.com/OpenAssetIO/OpenAssetIO/issues/1202

Current rendered version

Notebook Driven Development :wink:

[x] Design API by documentation / example sketches (notebook cannot be executed at this stage)
[x] Verify locally by executing notebook against proposed upstream changes, making tweaks to the design as necessary.
[x] Test final released upstream changes against the notebook as part of CI.
[x] Document by tidying / expanding the notebook to become fully-fledged documentation.

feltech commented 2 months ago

Some minor questions, but if I'm reading the code correctly, the code in these notebooks get run in the CI, so they _have to be correct or the CI will fail?

Yeah exactly. Unfortunately, since we don't publish SimpleCppManager, this notebook only runs in CI on Linux (Docker). I added https://github.com/OpenAssetIO/OpenAssetIO/issues/1408 as a consequence.

feltech commented 2 months ago

Thanks for the tweaks @feltech 🙏 - sorry I cant close that comment.

I struggle to find a setting in GitHub to allow users to resolve their own comments :disappointed: . Perhaps a :+1: is sufficient for now to signal you're happy for the comment to be resolved?

tomc-cinesite commented 2 months ago

Thanks for the tweaks @feltech 🙏 - sorry I cant close that comment.

I struggle to find a setting in GitHub to allow users to resolve their own comments 😞 . Perhaps a 👍 is sufficient for now to signal you're happy for the comment to be resolved?

Added thumbs up -thanks!