From 38230174e20fa4c1785429ccb9cede5127cd4a2e Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Thu, 18 May 2017 13:29:33 -0700 Subject: [PATCH] Deprecate onbuild variants (minus sentry:onbuild) --- .template-helpers/variant-onbuild.md | 2 +- python/variant-onbuild.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.template-helpers/variant-onbuild.md b/.template-helpers/variant-onbuild.md index 3711b19c1..0a31fa825 100644 --- a/.template-helpers/variant-onbuild.md +++ b/.template-helpers/variant-onbuild.md @@ -1,6 +1,6 @@ ## `%%IMAGE%%:onbuild` -This image makes building derivative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM %%IMAGE%%:onbuild` will be enough to create a stand-alone image for your project. +The `ONBUILD` image variants are deprecated, and their usage is discouraged. For more details, see [docker-library/official-images#2076](https://github.com/docker-library/official-images/issues/2076). While the `onbuild` variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over *when* the `ONBUILD` triggers fire (see also [`docker/docker#5714`](https://github.com/docker/docker/issues/5714), [`docker/docker#8240`](https://github.com/docker/docker/issues/8240), [`docker/docker#11917`](https://github.com/docker/docker/issues/11917)). diff --git a/python/variant-onbuild.md b/python/variant-onbuild.md index 79647d39a..43bc2e0c3 100644 --- a/python/variant-onbuild.md +++ b/python/variant-onbuild.md @@ -1,5 +1,7 @@ ## `%%IMAGE%%:onbuild` +The `ONBUILD` image variants are deprecated, and their usage is discouraged. For more details, see [docker-library/official-images#2076](https://github.com/docker-library/official-images/issues/2076). + This image feeds your `requirements.txt` file automatically to `pip` in order to make building derivative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM %%IMAGE%%:onbuild` will be enough to create a stand-alone image for your project. While the `onbuild` variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over *when* the `ONBUILD` triggers fire (see also [`docker/docker#5714`](https://github.com/docker/docker/issues/5714), [`docker/docker#8240`](https://github.com/docker/docker/issues/8240), [`docker/docker#11917`](https://github.com/docker/docker/issues/11917)).