nri icon indicating copy to clipboard operation
nri copied to clipboard

[Proposal] Remove or move the content about 0.1.0

Open Iceber opened this issue 8 months ago • 4 comments

0.1.0 represents a historical design and stage for NRI, but some packages related to it still appear in the main branch.

These include:

  • ./examples: Plugin examples for NRI 0.1.0
  • ./skel: NRI 0.1.0 running framework
  • ./types: NRI 0.1.0 API package
  • ./client: NRI 0.1.0 client package
  • ./README-v0.1.0.md

We may be able to delete or move these packages to ensure that the latest main branch is clean.

We could:

  1. Delete ./examples and ./skel. If users really need them, they can use the NRI package from the old tag.
  2. Move ./README-0.1.0.md, ./types, and ./client-go to ./plugins/v010-adapter.

Or, we don't delete anything, just move them to the ./0.1.0 directory. I've provided a branch to demonstrate the modified effect. https://github.com/Iceber/nri/tree/move_0.1.0

Iceber avatar Mar 28 '25 02:03 Iceber

Hi @mikebrow @klihub, what do you think?

Iceber avatar Mar 28 '25 02:03 Iceber

@Iceber @mikebrow I think it would make sense to either remove the original v0.1.0 bits or move them out of the way. Other than the in-repo v010-adapter plugin which needs access to the old API bits, removing these bits would be straightforward. So maybe moving the old bits out of the way under a 0.1.0 is the best thing we can do now, like you propose in your branch.

Considering that starting from v1.7, containerd does not depend on the v0.1.0 bits, another possibility would be to just move them under something like plugins/v010-adapter/0.1.0 and consume them from that location in the adapter plugin. This could be of some inconvenience to anybody who, unbeknownst to us, is still building and using v0.1.0 plugins, but I find that highly unlikely. We could then eventually deprecate and remove the v010-adapter plugin altogether, which would then also eliminate the original v0.1.0 bits.

klihub avatar Mar 28 '25 07:03 klihub

move is fair and deprecate could be discussed.. there were a few using these 0.1.0 style..

mikebrow avatar Mar 28 '25 16:03 mikebrow

  1. Delete ./examples and ./skel. If users really need them, they can use the NRI package from the old tag.
  2. Move ./README-0.1.0.md, ./types, and ./client-go to ./plugins/v010-adapter.

This seems reasonable to me.

samuelkarp avatar Mar 28 '25 20:03 samuelkarp