From f569c7f859e69f3e7480c1a66810b1215879fb35 Mon Sep 17 00:00:00 2001 From: Florin Patan Date: Mon, 28 Aug 2017 16:53:11 +0100 Subject: [PATCH] Explain the status of the project Following the discussion https://github.com/golang/dep/issues/1070#issuecomment-325352595 "Agreed, dep cannot currently be trusted to not make changes after the importers are run. The issue which tracks that is #908.", it is clear that the maintainers of the tool do not see it as a reliable project. As such, the users should be correctly informed about the status of the project and what are the goals in order to make it a production ready one. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 880dc8bbab..c61741b496 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,14 @@ ## Current status -`dep` is safe for production use. That means two things: +`dep` has achieved the following milestones: * Any valid metadata file (`Gopkg.toml` and `Gopkg.lock`) will be readable and considered valid by any future version of `dep`. -* The CLI UI is mostly stable. `dep init` and `dep ensure` are mostly set; `dep status` is likely to change a fair bit, and `dep prune` is [going to be absorbed into `dep ensure`](https://github.com/golang/dep/issues/944). -* Generally speaking, it has comparable or fewer bugs than other tools out there. -That said, keep in mind the following: +The next milestones need to be achieved in order to become safe for production grade usage: +* The CLI UI is mostly stable. `dep init` and `dep ensure` are mostly set; `dep status` is likely to change a fair bit, and `dep prune` is [going to be absorbed into `dep ensure`](https://github.com/golang/dep/issues/944). +* Generally speaking, it has comparable or fewer bugs than other tools out there. * `dep` is still changing rapidly. If you need stability (e.g. for CI), it's best to rely on a released version, not tip. * `dep`'s exported API interface will continue to change in unpredictable, backwards-incompatible ways until we tag a v1.0.0 release.