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

Remove ContainerRuntime class #23329

Open
markfields opened this issue Dec 13, 2024 · 0 comments · May be fixed by #23341
Open

Remove ContainerRuntime class #23329

markfields opened this issue Dec 13, 2024 · 0 comments · May be fixed by #23341
Assignees
@markfields
Labels
api deprecation Changes to a deprecated API triage

Comments

@markfields
Copy link
Member

markfields commented Dec 13, 2024 •
edited by azure-boards bot
Loading

Removing an API

The ContainerRuntime class will no longer be exported.

  • Where used as a type, use IContainerRuntime or IRuntime instead
  • Where used to call static method ContainerRuntime.loadRuntime, use the free function loadContainerRuntime instead

Context

This class is an implementation detail and should not be exposed. It makes it very difficult to iterate on that code.

Links
@markfields markfields added the api deprecation Changes to a deprecated API label Dec 13, 2024
@markfields markfields self-assigned this Dec 13, 2024
@markfields markfields mentioned this issue Dec 13, 2024
Merged
markfields added a commit that referenced this issue Dec 16, 2024
@markfields @alexvy86 @Josmithr
Deprecate ContainerRuntime class (#23331)
dc48446 
Precursor to #23329.

We intend to mark the class `ContainerRuntime` as `@internal` which will
give us great freedom to iterate on its internals freely - it is an
implementation detail after all! To do so we need to put it on a
deprecation path so any few remaining usages in partner code are
migrated off `ContainerRuntime`, like so:

* When using it as a type, replace it with an interface like
`IContainerRuntime` (or in rare cases, `IRuntime`)
* When using the static function `ContainerRuntime.loadRuntime` replace
it with the free function `loadContainerRuntime`.

---------

Co-authored-by: Alex Villarreal <[email protected]>
Co-authored-by: Joshua Smithrud <[email protected]>
@markfields markfields linked a pull request Dec 17, 2024 that will close this issue
Draft
@markfields markfields linked a pull request Dec 17, 2024 that will close this issue
[For 2.20] Move ContainerRuntime class to internal scope #23341
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@markfields markfields

Labels
api deprecation Changes to a deprecated API triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[For 2.20] Move ContainerRuntime class to internal scope markfields/FluidFramework
1 participant
@markfields