From 52e17f2a9c0347171ff9fde9b3913b1572cb5973 Mon Sep 17 00:00:00 2001 From: Patrick Lang Date: Mon, 23 Sep 2019 10:25:37 -0700 Subject: [PATCH 1/2] doc: clarify usage & deprecated tags --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 15b39181a5..482e85b79a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ This package contains the Golang interface for using the Windows [Host Compute S It is primarily used in the [Moby Project](https://github.com/moby/moby), but it can be freely used by other projects as well. +This is a code-only repository and does not have a stable release. 0.8.6 is the last tagged release, and it is out of date for ContainerD and Kubernetes. Downstream projects should vendor in this codebase using commit ids instead of tags, then validate fixes and do a full test pass of the whole project. + ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a From 903b5a4572f8ba5f22bbd4d49015a51a901e0fc7 Mon Sep 17 00:00:00 2001 From: Patrick Lang Date: Thu, 10 Oct 2019 12:56:50 -0700 Subject: [PATCH 2/2] Updating with PR feedback --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 482e85b79a..d427856826 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This package contains the Golang interface for using the Windows [Host Compute S It is primarily used in the [Moby Project](https://github.com/moby/moby), but it can be freely used by other projects as well. -This is a code-only repository and does not have a stable release. 0.8.6 is the last tagged release, and it is out of date for ContainerD and Kubernetes. Downstream projects should vendor in this codebase using commit ids instead of tags, then validate fixes and do a full test pass of the whole project. +The tags in this repo are from a vendoring scheme intended the Docker repos, and is only stable for the v1 container and process API's. Newer projects vendoring this repo such as ContainerD or Kubernetes should use commit ids instead of tags, then validate fixes and do a test pass of the whole project. Hcsshim is not tested or released as an isolated unit. ## Contributing