Skip to content

Add Image(s)::save() and deprecate export() #258

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

Closed
wants to merge 1 commit into from

Conversation

elihunter173
Copy link
Contributor

What did you implement:

I renamed Image::export() to Image::save() and did the same for Images to make their naming inline with the Go API and the docker CLI.

I discovered an old issue #184 that mentions this and I tend to agree that it would be good to use consistent terminology.

Closes: #184

How did you verify your change:

Ran tests locally.

What (if anything) would need to be called out in the CHANGELOG for the next release:

Mention that Image(s)::export() has been deprecated in favor of Image(s)::save(). (Already done.)

@elihunter173
Copy link
Contributor Author

Just realized that I made a typo in one of the return types. Should compile and pass all tests again.

Copy link
Collaborator

@matthiasbeyer matthiasbeyer left a comment

Choose a reason for hiding this comment

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

Looks good in general.

Just a quick question: We're deprecating functions only on master and delete them before the release in this crate, is that correct? Because I'd imagine that we rather deprecate, release, then remove and make them gone in one release further. So the deprecation would remove them after the 0.8.0 release.

I'm fine either way, just confused why it is done this way and not the other.

@@ -15,6 +15,7 @@
* support for uploading tar to container [#239](https://github.com/softprops/shiplift/pull/239)
* fix registry authentication to use URL-safe base64 encoding [#245](https://github.com/softprops/shiplift/pull/245)
* add StopSignal and StopTimeout to ContainerOptionsBuilder [#248](https://github.com/softprops/shiplift/pull/248)
* add Image(s)::save() and deprecate Image(s)::export() [#257](https://github.com/softprops/shiplift/pull/257)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess this have to be in the changelog for the next one, not for the existing one, right? 😆

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Question: should Image.export be renamed to save?
3 participants