Begin process of deprecating MAINTAINER #25466

Merged
merged 1 commit into from Sep 13, 2016

Projects

None yet

9 participants

@justincormack
Member
justincormack commented Aug 6, 2016 edited

This may take some time, but start by pointing people at
LABEL instead.

MAINTAINER predates general LABEL and has basically no tooling,
only allows a single item to be added, and is has been
unofficially deprecated for some time, with many images not
including it, but we have never specifically said that it
should be replaced by LABEL as a better more generic metadata
solution.

Signed-off-by: Justin Cormack justin.cormack@docker.com

badger badger badger

I would imagine that we would not remove support for some considerable time. One option would be to simply treat the MAINTAINER line as a noop in a few releases.

cc @thaJeztah @SvenDowideit I picked a few places in the docs to remove it, but there are more, could add here.

closes #18921

@duglin
Contributor
duglin commented Aug 6, 2016

Can we get some docs started that call-out "well defined" label names - like "maintainer" so that people have a consistent usage pattern? Maintainer vs MAINTAINER vs maintainer vs author.... can lead to a usability issue.

@justincormack
Member

There exist general schemas eg Dublin Core
http://dublincore.org/documents/dcmi-terms/

Also draft container specific scheme at http://label-schema.org

I don't know of anything else targeted at software specifically, none of
the packaging formats seemed to use standards.

I do agree standardisation would be helpful.

On 6 Aug 2016 18:01, "Doug Davis" notifications@github.com wrote:

Can we get some docs started that call-out "well defined" label names -
like "maintainer" so that people have a consistent usage pattern?
Maintainer vs MAINTAINER vs maintainer vs author.... can lead to a
usability issue.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#25466 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAdcPB0vBqpkdtVnmObAsOWOPub6rIeQks5qdK_vgaJpZM4JeRba
.

@justincormack
Member

@thaJeztah added there....

@SvenDowideit SvenDowideit commented on an outdated diff Aug 12, 2016
docs/reference/builder.md
@@ -681,6 +674,15 @@ To view an image's labels, use the `docker inspect` command.
"other": "value3"
},
+## MAINTAINER (deprecated)
+
+ MAINTAINER <name>
+
+The `MAINTAINER` instruction sets the *Author* field of the generated images.
+The `LABEL` instruction is a much more flexible version of this and you should use
+it instead, as it enables setting any metadata you require, and can be viewed
+easily, for example with `docker inspect`.
@SvenDowideit
SvenDowideit Aug 12, 2016 Collaborator

can you an an explicit example of using the LABEL instruction?

@justincormack
Member
@thaJeztah
Member

One option would be to simply treat the MAINTAINER line as a noop in a few releases.

If we want to do that, we should decide on a release (default deprecation policy is 3 releases now, but we can diverge from that), and mention that release in the deprecated.md

@thaJeztah
Member

LGTM

@thaJeztah
Member

but /cc @shykes (I think) 😄

@tianon
Member
tianon commented Aug 12, 2016

+1! I stopped using the MAINTAINER instruction ages ago, essentially for the reasons you've outlined -- the only "tooling" that displays it is docker inspect, it's inherited by sub-images (and thus if it's not used 100% consistently by all authors, the results "bleed" -- I don't want credit for the Dockerfiles based on mine 😇), and it used to waste a layer. 😄

@tianon tianon commented on the diff Aug 12, 2016
docs/tutorials/dockerimages.md
@@ -294,10 +293,7 @@ Now let's take our `Dockerfile` and use the `docker build` command to build an i
Sending build context to Docker daemon
Step 1 : FROM ubuntu:14.04
---> e54ca5efa2e9
- Step 2 : MAINTAINER Kate Smith <ksmith@example.com>
- ---> Using cache
- ---> 851baf55332b
- Step 3 : RUN apt-get update && apt-get install -y ruby ruby-dev
+ Step 2 : RUN apt-get update && apt-get install -y ruby ruby-dev
@tianon
tianon Aug 12, 2016 Member

Don't the following step numbers need to be updated too? (see Step 4 following this now Step 2)

@justincormack
justincormack Aug 12, 2016 Member

yup, will update thanks

@tonistiigi
Contributor

@justincormack Does it mean deprecating https://github.com/docker/docker/blame/master/image/spec/v1.1.md#L184 as well as there will be no way to fill that field.

@SvenDowideit SvenDowideit commented on the diff Aug 12, 2016
docs/reference/builder.md
@@ -681,6 +674,20 @@ To view an image's labels, use the `docker inspect` command.
"other": "value3"
},
+## MAINTAINER (deprecated)
+
+ MAINTAINER <name>
+
+The `MAINTAINER` instruction sets the *Author* field of the generated images.
+The `LABEL` instruction is a much more flexible version of this and you should use
+it instead, as it enables setting any metadata you require, and can be viewed
+easily, for example with `docker inspect`. To set a label corresponding to the
+`MAINTAINER` field you could use:
+
+ LABEL maintainer "SvenDowideit@home.org.au"
@SvenDowideit
SvenDowideit Aug 12, 2016 Collaborator

well that deserves a LGTM from me 🍭

@thaJeztah
thaJeztah Aug 12, 2016 Member

yes noticed 😉

@ripcurld0
Contributor
ripcurld0 commented Aug 18, 2016 edited

LGTM 👍

@ripcurld0 ripcurld0 referenced this pull request in shlomizadok/foreman-docker-compose Aug 20, 2016
Merged

Use LABEL to specify the maintainer #4

@vdemeester
Member

@justincormack needs a rebase 👼

Also, I do agree with @tonistiigi

@justincormack Does it mean deprecating https://github.com/docker/docker/blame/master/image/spec/v1.1.md#L184 as well as there will be no way to fill that field.

@justincormack
Member

Will rebase.

I don't know exactly how/when we deprecate that field, do we do it when we actually eg stop filling it in from MAINTAINER? or now?

@justincormack justincormack Begin process of deprecating MAINTAINER
This may take some time, but start by pointing people at
LABEL instead.

MAINTAINER predates general LABEL and has basically no tooling,
only allows a single item to be added, and is has been
unofficially deprecated for some time, with many images not
including it, but we have never specifically said that it
should be replaced by LABEL as a better more generic metadata
solution.

Signed-off-by: Justin Cormack <justin.cormack@docker.com>
efb9e38
@vdemeester
Member

I don't know exactly how/when we deprecate that field, do we do it when we actually eg stop filling it in from MAINTAINER? or now?

I would say first one when we actually stop filling it 👼

@SvenDowideit
Collaborator
@vdemeester
Member

LGTM 🐸 as is, and we can do the rest in follow-up (and even in later versions)
/cc @thaJeztah

@thaJeztah thaJeztah added this to the 1.13.0 milestone Sep 13, 2016
@thaJeztah
Member

re-LGTM, thanks!

@thaJeztah thaJeztah merged commit 4d187df into docker:master Sep 13, 2016

2 checks passed

docker/dco-signed All commits signed
Details
documentation success
Details
@justincormack justincormack deleted the justincormack:deprecate-maintainer branch Sep 13, 2016
@TimWolla TimWolla added a commit to TimWolla/docker-spiped that referenced this pull request Nov 13, 2016
@TimWolla TimWolla Remove MAINTAINER line from Dockerfiles caa1ecb
@TimWolla TimWolla referenced this pull request in TimWolla/docker-spiped Nov 13, 2016
Merged

Remove MAINTAINER line from Dockerfiles #11

@TimWolla TimWolla added a commit to TimWolla/docker-adminer that referenced this pull request Nov 13, 2016
@TimWolla TimWolla Remove MAINTAINER line from Dockerfiles 66fd66f
@TimWolla TimWolla added a commit to TimWolla/docker-znc that referenced this pull request Nov 13, 2016
@TimWolla TimWolla Remove MAINTAINER line from Dockerfiles 0a83113
@singingwolfboy singingwolfboy added a commit to mitodl/micromasters that referenced this pull request Nov 15, 2016
@singingwolfboy singingwolfboy MAINTAINER is deprecated in Dockerfiles 2c54dc3
@singingwolfboy singingwolfboy referenced this pull request in mitodl/micromasters Nov 15, 2016
Merged

MAINTAINER is deprecated in Dockerfiles #1759

@singingwolfboy singingwolfboy added a commit to mitodl/micromasters that referenced this pull request Nov 15, 2016
@singingwolfboy singingwolfboy MAINTAINER is deprecated in Dockerfiles (#1759) 27b95dc
@tianon tianon referenced this pull request in docker-library/redis Nov 17, 2016
Merged

Server Core support #78

@cturra cturra added a commit to cturra/docker-plexmediaserver that referenced this pull request Nov 19, 2016
@cturra cturra MAINTAINER will soon become deprecated
starting in docker-engine 1.13.0 the MAINTAINER command in the
Dockerfile will beging the process of being deprecated. since
we're already tracking maintainers in the CONTRIBUTORS file, there
is no need for this command/layer anyway.

docker project ref: docker/docker#25466
5b305a3
@cturra cturra referenced this pull request in cturra/docker-plexmediaserver Nov 19, 2016
Merged

MAINTAINER will soon become deprecated #12

@bfirsh bfirsh added a commit to bfirsh/docker-py that referenced this pull request Nov 24, 2016
@bfirsh bfirsh Remove MAINTAINER from Dockerfiles
It was deprecated in docker/docker#25466

(Sorry @shin- ;)

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
b4c0239
@shin- shin- added a commit to docker/docker-py that referenced this pull request Dec 8, 2016
@bfirsh @shin- bfirsh + shin- Remove MAINTAINER from Dockerfiles
It was deprecated in docker/docker#25466

(Sorry @shin- ;)

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
73b34ef
@ganta ganta added a commit to ganta/docker-elasticsearch that referenced this pull request Dec 15, 2016
@ganta ganta Remove MAINTAINER
Because it is deprecated.
docker/docker#25466
dc9e026
@wikier wikier added a commit to redlink-gmbh/base-dev that referenced this pull request Dec 21, 2016
@wikier wikier MAINTAINER is deprecated in Dockerfiles, see docker/docker#25466 7649a8b
@wikier wikier added a commit to redlink-gmbh/base-dev that referenced this pull request Dec 21, 2016
@wikier wikier MAINTAINER is deprecated in Dockerfiles, see docker/docker#25466 130d340
@kinghuang kinghuang added a commit to ucalgary/docker-glassfish that referenced this pull request Jan 7, 2017
@kinghuang kinghuang Remove MAINTAINER instruction
The MAINTAINER instruction in Dockerfiles is deprecated as of Docker
1.13.

https://github.com/docker/docker/blob/master/docs/deprecated.md#maintain
er-in-dockerfile
docker/docker#25466
1a3ddea
@kinghuang kinghuang added a commit to ucalgary/docker-kafka that referenced this pull request Jan 8, 2017
@kinghuang kinghuang Replace MAINTAINER instruction
Replace the MAINTAINER instruction with a label. The MAINTAINER
instruction is deprecated starting in Docker 1.13.

docker/docker#25466
9e7a673
@kinghuang kinghuang added a commit to ucalgary/docker-kafka-rest that referenced this pull request Jan 8, 2017
@kinghuang kinghuang Replace MAINTAINER with LABEL
Replace the MAINTAINER instruction with a LABEL. MAINTAINER is
deprecated starting in Docker 1.13.

docker/docker#25466
9b414fc
@kinghuang kinghuang added a commit to ucalgary/docker-schema-registry that referenced this pull request Jan 8, 2017
@kinghuang kinghuang Convert MAINTAINER to LABEL
Convert the MAINTAINER instruction into a label. MAINTAINER is
deprecated starting with Docker 1.13.

docker/docker#25466
40166a3
@sathieu sathieu added a commit to nantesmetropole/docker-debian that referenced this pull request Jan 12, 2017
@sathieu sathieu MAINTAINER is deprecated 5fc7cac
@sathieu sathieu referenced this pull request in nantesmetropole/docker-debian Jan 12, 2017
Merged

MAINTAINER is deprecated #2

@sathieu sathieu added a commit to nantesmetropole/docker-paas that referenced this pull request Jan 12, 2017
@sathieu sathieu MAINTAINER is deprecated ef9eb47
@sathieu sathieu added a commit to nantesmetropole/docker-paas that referenced this pull request Jan 12, 2017
@sathieu sathieu MAINTAINER is deprecated 4b4889f
@sathieu sathieu added a commit to nantesmetropole/docker-debian that referenced this pull request Jan 12, 2017
@sathieu sathieu MAINTAINER is deprecated 1f3facb
@ushuz ushuz added a commit to ushuz/docker-library that referenced this pull request Jan 13, 2017
@ushuz ushuz Remove MAINTAINER
It's deprecated, see docker/docker#25466.
6ad5fd2
@MichaelPereira MichaelPereira added a commit to MichaelPereira/docker.github.io that referenced this pull request Jan 31, 2017
@MichaelPereira MichaelPereira Replace deprecated MAINTAINER with LABEL
Replace MAINTAINER instruction with LABEL as MAINTAINER was deprecated in docker/docker#25466
f0f0d8e
@naoki-k naoki-k added a commit to naoki-k/latex-on-docker that referenced this pull request Feb 4, 2017
@naoki-k naoki-k Fix Dockerfiles bfda49a
@endersonmaia endersonmaia added a commit to endersonmaia/zabbix-docker that referenced this pull request Feb 7, 2017
@endersonmaia endersonmaia MAINTAINER is deprecated
See docker/docker#25466

Signed-off-by: Enderson Maia <endersonmaia@gmail.com>
be93758
@endersonmaia endersonmaia added a commit to endersonmaia/zabbix-docker that referenced this pull request Feb 7, 2017
@endersonmaia endersonmaia Switching from `MAINTAINER` to `LABEL maintainer`
MAINTAINER is deprecatedi, see docker/docker#25466

Signed-off-by: Enderson Maia <endersonmaia@gmail.com>
120e4fc
@endersonmaia endersonmaia referenced this pull request in zabbix/zabbix-docker Feb 7, 2017
Open

Switching from `MAINTAINER` to `LABEL maintainer` #81

@ume3 ume3 added a commit to ume3/docker-embulk that referenced this pull request Feb 8, 2017
@ume3 ume3 rename: MAINTAINER -> LABEL a81ddae
@TomasTomecek TomasTomecek referenced this pull request in projectatomic/ContainerApplicationGenericLabels Feb 13, 2017
Closed

maintainer instruction is deprecated as of docker engine 1.13 #78

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment