Skip to content
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

docs/deprecated: update status of short cid alias deprecation #4949

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

akerouanton
Copy link
Member

- What I did

Starting with API v1.45, the container short ID is removed from the container Aliases. Update the status for that deprecation.

Starting with API v1.45, the container short ID is removed from the
container Aliases.

Signed-off-by: Albin Kerouanton <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #4949 (f96d8e7) into master (38fcd1c) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4949   +/-   ##
=======================================
  Coverage   61.43%   61.43%           
=======================================
  Files         289      289           
  Lines       20241    20241           
=======================================
  Hits        12435    12435           
  Misses       6904     6904           
  Partials      902      902           

Copy link
Contributor

@robmry robmry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thaJeztah
Copy link
Member

Do we need to mention that it's deprecated for API XX, but older API versions still having it?

@akerouanton
Copy link
Member Author

Do we need to mention that it's deprecated for API XX, but older API versions still having it?

Is that something we usually do in docs/deprecated.md? Except for "Deprecate legacy API versions", it seems we never advertise the use of DOCKER_API_VERSION.

@thaJeztah
Copy link
Member

It's a bit similar to #4893 (comment) - we don't recommend DOCKER_API_VERSION, but clients that were created for an older version of the API should continue to observe the old behavior (i.e., older API versions are not "touched").

We should probably look (as discussed in the other PR) to more prominently add a link to the API history, as that's effectively the source of truth for API changes (including deprecations)

@akerouanton
Copy link
Member Author

It's a bit similar to #4893 (comment) - we don't recommend DOCKER_API_VERSION, but clients that were created for an older version of the API should continue to observe the old behavior (i.e., older API versions are not "touched").

Then, should we mention that only newer CLI versions are affected, ie. CLI v26 and above?

Copy link
Member

@neersighted neersighted left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glancing at previous deprecations, this should be sufficient on the CLI side.

The 1.45 deprecation does not mention the change telegraphed in 1.44:

https://github.com/moby/moby/blob/963e1f3eed52024629557c11503c56f28d578f55/docs/api/version-history.md?plain=1#L16-L27

https://github.com/moby/moby/blob/963e1f3eed52024629557c11503c56f28d578f55/docs/api/version-history.md?plain=1#L86-L90

I think all we need to do is make sure to add the change to API 1.45; with that change, this LGTM.

@vvoland vvoland merged commit ed9dd75 into docker:master Mar 20, 2024
88 checks passed
@akerouanton akerouanton deleted the remove-short-cid-alias branch April 3, 2024 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants