[TBD] api/types/image: InspectResponse: deprecate Author#51107
Draft
thaJeztah wants to merge 1 commit intomoby:masterfrom
Draft
[TBD] api/types/image: InspectResponse: deprecate Author#51107thaJeztah wants to merge 1 commit intomoby:masterfrom
Author#51107thaJeztah wants to merge 1 commit intomoby:masterfrom
Conversation
The `Author` field can be set through the `MAINTAINER` instruction in Dockerfiles, and through the `--author` option on `docker commit`, but is optional, and won't be set in most situations. This patch deprecates the fields in the `InspectResponse` go struct. The `Author` field can still be set but is deprecated in the Dockerfile syntax, so should not be depended on. This field was implicitly deprecated when the `MAINTAINER` command was deprecated in [moby/moby@efb9e38] / [moby/moby@6694974] (docker 1.13, API v1.25), however the related API fields were kept so that information of legacy images would not be discarded. The API continues to return the field if set, allowing the client to print the fields for informational purposes when printing the raw response, but these fields should be considered "transitional", and not be depended on; deprecating the fields helps raise awareness. [moby/moby@efb9e38]: moby@efb9e38 [moby/moby@6694974]: moby@6694974 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
97a98eb to
982cd93
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
relates to:
api/types/image: InspectResponse: deprecate
AuthorThe
Authorfield can be set through theMAINTAINERinstruction inDockerfiles, and through the
--authoroption ondocker commit, butis optional, and won't be set in most situations.
This patch deprecates the fields in the
InspectResponsego struct. TheAuthorfield can still be set but is deprecated in the Dockerfile syntax,so should not be depended on. This field was implicitly deprecated when
the
MAINTAINERcommand was deprecated in moby@efb9e38 / moby@6694974(docker 1.13, API v1.25), however the related API fields were kept so
that information of legacy images would not be discarded.
The API continues to return the field if set, allowing the client to
print the fields for informational purposes when printing the raw response,
but these fields should be considered "transitional", and not be depended
on; deprecating the fields helps raise awareness.
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)