New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Begin process of deprecating MAINTAINER #25466

Merged
merged 1 commit into from Sep 13, 2016

Conversation

Projects
None yet
9 participants
@justincormack
Contributor

justincormack commented Aug 6, 2016

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

This comment has been minimized.

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

This comment has been minimized.

Contributor

justincormack commented Aug 6, 2016

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
.

@thaJeztah

This comment has been minimized.

Member

thaJeztah commented Aug 6, 2016

@justincormack justincormack force-pushed the justincormack:deprecate-maintainer branch from a2aa8a7 to 200b121 Aug 6, 2016

@justincormack

This comment has been minimized.

Contributor

justincormack commented Aug 6, 2016

@thaJeztah added there....

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`.

This comment has been minimized.

@SvenDowideit

SvenDowideit Aug 12, 2016

Contributor

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

@justincormack justincormack force-pushed the justincormack:deprecate-maintainer branch from 200b121 to abb8a6c Aug 12, 2016

@justincormack

This comment has been minimized.

Contributor

justincormack commented Aug 12, 2016

@thaJeztah

This comment has been minimized.

Member

thaJeztah commented Aug 12, 2016

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

This comment has been minimized.

Member

thaJeztah commented Aug 12, 2016

LGTM

@thaJeztah

This comment has been minimized.

Member

thaJeztah commented Aug 12, 2016

but /cc @shykes (I think) 😄

@tianon

This comment has been minimized.

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. 😄

---> 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

This comment has been minimized.

@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)

This comment has been minimized.

@justincormack

justincormack Aug 12, 2016

Contributor

yup, will update thanks

This comment has been minimized.

@justincormack

justincormack Aug 12, 2016

Contributor

amended

@justincormack justincormack force-pushed the justincormack:deprecate-maintainer branch from abb8a6c to 5813ad7 Aug 12, 2016

@tonistiigi

This comment has been minimized.

Member

tonistiigi commented Aug 12, 2016

@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.

easily, for example with `docker inspect`. To set a label corresponding to the
`MAINTAINER` field you could use:
LABEL maintainer "SvenDowideit@home.org.au"

This comment has been minimized.

@SvenDowideit

SvenDowideit Aug 12, 2016

Contributor

well that deserves a LGTM from me 🍭

This comment has been minimized.

@thaJeztah

thaJeztah Aug 12, 2016

Member

yes noticed 😉

@boaz1337

This comment has been minimized.

Member

boaz1337 commented Aug 18, 2016

LGTM 👍

@vdemeester

This comment has been minimized.

Member

vdemeester commented Aug 25, 2016

@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

This comment has been minimized.

Contributor

justincormack commented Aug 25, 2016

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?

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>

@justincormack justincormack force-pushed the justincormack:deprecate-maintainer branch from 5813ad7 to efb9e38 Aug 25, 2016

@vdemeester

This comment has been minimized.

Member

vdemeester commented Aug 25, 2016

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

This comment has been minimized.

Contributor

SvenDowideit commented Sep 13, 2016

@vdemeester

This comment has been minimized.

Member

vdemeester commented Sep 13, 2016

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

mistyhacks added a commit to docker/docker.github.io that referenced this pull request Mar 2, 2017

Replace deprecated MAINTAINER with LABEL (#1445)
Replace MAINTAINER instruction with LABEL as MAINTAINER was deprecated in moby/moby#25466

PereiraHugo added a commit to MichaelPereira/docker.github.io that referenced this pull request Mar 2, 2017

Replace deprecated MAINTAINER with LABEL
Replace MAINTAINER instruction with LABEL as MAINTAINER was deprecated in moby/moby#25466

johndmulhausen pushed a commit to docker/docker.github.io that referenced this pull request Mar 2, 2017

Docker 17.03 release (#2050)
* First pass of tabs-based organization

* Improvements

* Second pass at tabs org

* Move tab highlighting to Liquid instead of JS

* Adding forwarding links for in-product TOCs

* Move to pre-rendered left-navs instead of post-load JS for TOC sync

* Optimizations and nosync-ing the Reference section

* Optimizations, fix Cloud YAML

* Make a "Sample applications" node

* Update index.md

* Tabs CSS fixes and 12-factor reposition

* Theme Start (#1709)

* Hooking up nav to real TOC data, formatting fixes

* Fixing JS error

* Layout updates, dark themes, tons o stuff (#1971)

* Add cookie saving for day/night mode

* Newsite tabs (#2004)

* Layout updates, dark themes, tons o stuff

* Update themes

Theme updates + scaffolding

* Update style.css

* Update style-alt.css

* Missing font fixes

* Import Open Sans from Google

* Font fix, archive removal in TOC, favicon, Feedback img fix

* Oops, returning -webkit-font-smoothing: antialiased;

* Add old favicon.ico

* Make archives a non-tiered link

* Reorder docs archive to newest-first, add local instructions

* Commenting out day/night switch for now

* Fix 'rate this page'

* Rate this page fixes

* Autocomplete and Docker Cloud fixes

* Open tree to current page

* Adding indentation for nav collapse in

* Ensure left nav visibly displays the current topic

* Update flex layout

- adjust rescale
- code block styles

* add focus to search

- force code block color (for now)
- increase section max-width

* increase content padding

- add padding to toc for wrapping long strings.

* grid adjustment

- grid
- content and wrapper adjustments for mobile

* left/right sidebar adjustments

- refine position on scroll for toc on landing

- add default height to compensate for upcoming position absolute
onScroll

* side bar overflow

- hidden on X-scroll

* fix version button

- override bstrap defaults

* tabs + buttons

* update landing svgs

* fix sidebar height

set to 100% on landing pre-affix

* Update blurb about engine/editions on front page

* add side menu to mobile collapse menu

* update classnames

* overall mobile tweaks

* Right-nav highlighting and auto-scroll

* Slightly slower right-nav highlighting, correct version

* add toggle menus for small devices

* Fixing JS error/Docker 1.13>17.03

* header updates

* re-add fan to header

* update transition time

* Add first 20 words to Twitter card

* fixed width of components

- lockdown elements on rescale (wil need more TLC)

* set max-width of content

* Left and right nav resizing w/footer scroll and window resize

* update links on landing page

* Fix for overzealous resizing, JS redundancies

* Fix for JS error on homepage

* JS error fixes

* toggle adjustments

- wrap toggle button

* add tab width

* version button type

* version button both headers

* tabs - fix typo

* landing page grid

* components

* Share images, JS fixes, Marketo removal

* Anchor links fix

* Fix for black space on mobile

* Restore hamburger (partial)

* Update run.md

Minor grammar cleanup.

* Update apparmor.md

I'm a little confused about which one is better to be used here, a period (.) or a colon (:),  as a command is given below. Or both are OK, and we only have to keep consistency in a single page.

* Update apparmor.md

Fixed the indentation for the codeblock (indented by 4 spaces). Thank you for your careful review.

* Replacing service with secret

* Update networking.md

fix typo with triple "m" for command word

* Update run.md

Address PR feedback.

* Update install instructions to latest version

* Added "related topics" section

* Add documentation for mem_swappiness

* Update to new Docker version scheme (#1926)

* mem_swappiness for current version and v1

* merge other changes, fix typo

* There is no OpenSuSE and there never was

though we had SuSE and S.u.S.E.

* Add release notes for 1.12.6-cs9 (#2028)

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

* need sudo to access key cache (#1931)

* need sudo to access key cache

* List other keyservers to try for cs-engine install (#2033)

* List other keyservers to try for cs-engine install

Sometimes ha.pool.sks-keyservers.net goes down, so let's provide some
other keyservers to try in such cases.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

* Update work_issue.md (#2030)

Change "re-start" to "restart". Though not included in "Prefered usages" in the documentation guide, but I think "restart" is better and used more frequently. Besides, some other docs here, such as "Keep containers alive during daemon downtime" of "Admin Guide", also use "restart".

* Update create_pr.md (#2015)

* Update work_issue.md (#2013)

Change "id" to "ID" except for those in code.

* Update set_up_dev.md (#2011)

Add periods (.) in some steps.

* Update set_up_dev.md (#2010)

Apply Oxford Comma as described in the documentation guide.

* Update create_pr.md (#2014)

Delete an extra space.

* Update trust_key_mng.md (#1883)

* Update trust_key_mng.md

* Update trust_key_mng.md

I don‘t know how the whitespace appears, and it seems that it appears because something happened related to its original format (right-aligned pipe characters) and my change. Still unknown. 

Now I've deleted some redundant whitespace.

* Update 

I don‘t know how the whitespace appears, and it seems that it appears because something happened related to its original format (right-aligned pipe characters) and my change. Still unknown. 

Now I've deleted some redundant whitespace.

* Update content_trust.md (#1912)

* Update content_trust.md

* update deprecation policy

Signed-off-by: Victor Vieux <victorvieux@gmail.com>

* Update info about how to check whether Docker is running

* Updated docs to reflect edge channel

Signed-off-by: French Ben <frenchben@docker.com>

* Updated wording for SP creation

Signed-off-by: French Ben <frenchben@docker.com>

* beta to edge, cloud features first draft

added cloud images

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Distinguish between cloud stack file and stack file

* Added EE links

Signed-off-by: French Ben <frenchben@docker.com>

* Use variables

Signed-off-by: French Ben <frenchben@docker.com>

* Replace deprecated MAINTAINER with LABEL (#1445)

Replace MAINTAINER instruction with LABEL as MAINTAINER was deprecated in moby/moby#25466

* Updates for Docker CE and Docker EE

* Updated DDC launch button

Signed-off-by: French Ben <frenchben@docker.com>

* added Docker Cloud topics for Mac and Windows

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* d4mac, d4win stable and beta release notes for 17.03.0

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

@sross07 sross07 referenced this pull request Apr 5, 2017

Merged

Maintainer fix #5

jphuynh added a commit to jphuynh/docker that referenced this pull request Apr 18, 2017

MAINTAINER deprecation follow up. Relates to moby#25466
Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>

grempe added a commit to chainpoint/chainpoint-services that referenced this pull request Apr 26, 2017

thaJeztah added a commit that referenced this pull request May 13, 2017

Merge pull request #32700 from jphuynh/more-maintainer-deprecation
MAINTAINER deprecation follow up. Relates to #25466

anonymuse added a commit to anonymuse/docker that referenced this pull request May 19, 2017

MAINTAINER deprecation follow up. Relates to moby#25466
Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>

naoki912 pushed a commit to nee-co/nee-co that referenced this pull request Jun 12, 2017

zakame added a commit to zakame/docker-perl that referenced this pull request Aug 12, 2017

Update maintainers in Dockerfiles
`MAINTAINER` Dockerfile directive is now deprecated (see
moby/moby#25466) so update generate.pl to use
`LABEL` instead.  This is also a good time to add myself :)

Regenerate the Dockerfiles as well for sync.

tamalsaha pushed a commit to kubeware/fluentd-elasticsearch that referenced this pull request Mar 11, 2018

Merge pull request #38927 from luxas/remove_maintainer
Automatic merge from submit-queue

Remove all MAINTAINER statements in the codebase as they are deprecated

**What this PR does / why we need it**:
ref: moby/moby#25466

**Release note**:

```release-note
Remove all MAINTAINER statements in Dockerfiles in the codebase as they are deprecated by docker
```
@ixdy @thockin (who else should be notified?)

tamalsaha pushed a commit to kubeware/fluentd-gcp that referenced this pull request Mar 11, 2018

Merge pull request #38927 from luxas/remove_maintainer
Automatic merge from submit-queue

Remove all MAINTAINER statements in the codebase as they are deprecated

**What this PR does / why we need it**:
ref: moby/moby#25466

**Release note**:

```release-note
Remove all MAINTAINER statements in Dockerfiles in the codebase as they are deprecated by docker
```
@ixdy @thockin (who else should be notified?)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment