Establish internal/private.ImageDestination #1462
Merged
Conversation
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
The goal is to establish a practical/convenient naming for internal-only interfaces, now that we are going to start using them much more frequently. Design concerns: - Don't duplicate any public package name (to avoid the publicTypes/internalTypes names in every single user). Rules out "types", "image" (as in "image.Destination"). - Don't just use "internal", to keep that around for very localized private utilities, like oci/internal "private", as a more or less synonym to "internal", seems to work acceptably well: we will have types.ImageDestination and private.ImageDestination. Signed-off-by: Miloslav Trmač <[email protected]>
... to ensure we don't break anything by refactoring. Signed-off-by: Miloslav Trmač <[email protected]>
We now have types.ImageDestination (public) and private.ImageDestination. Signed-off-by: Miloslav Trmač <[email protected]>
... purely to be consistent with public types.ImageDestination. Signed-off-by: Miloslav Trmač <[email protected]>
Document the API of the methods, not how it differs from other methods. Signed-off-by: Miloslav Trmač <[email protected]>
Member
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Based on the #1439 experiment, this is trying to establish the common type, so that we can then separately work on the client-side wrapper, and the implementation-side compat/helper infrastructure.
This includes some commits from #1439; the new part is a proposal to, instead of using
publicTypes "…/v5/types" andinternalTypes "…/v5/internal/types, withinternalTypes.ImageDestinationWithOptions, to usetypes "…/v5/types"(as we used to) andprivate "…/v5/internal/private", withprivate.ImageDestination`.The “private” name, as well as all other aspects, is certainly open for debate.
See individual commits for details.
@vrothberg WDYT?