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

Reinstate and deprecate older methods to preserve binary backward compatibility with 1.0.4 #667

Merged
merged 2 commits into from
Sep 10, 2015

Conversation

fsat
Copy link
Collaborator

@fsat fsat commented Sep 10, 2015

The methods in question are the methods used to create various kinds of archives (e.g. zip or tar) from com.typesafe.sbt.packager.universal.Archives

@fsat fsat force-pushed the deprecate-old-archives-methods branch from dcf7f95 to 4569229 Compare September 10, 2015 04:50
@fsat
Copy link
Collaborator Author

fsat commented Sep 10, 2015

@muuki88 - I'm putting back older methods in the com.typesafe.sbt.packager.universal.Archives and marking them as deprecated to preserve backward binary compatibility with 1.0.4.

There's one problem however, I can't put back older version of the makeTarball method.

I can’t overload makeTarball with older version of the method due to the fact options argument introduced in the second group of arguments.

Can I suggest we move the existing makeTarball to a new method called makeTarballWithOptions, and reinstate older makeTarball method? This way, the backward compatibility will be maintained, and we can have the fix for #662.

I'm happy to discuss further if you'd like.

//cc @huntc

* @return zip file
*/
@deprecated(
"Use [[com.typesafe.sbt.packager.universal.Archives.makeZip(File, String, Seq[(File, String)], Option[String], Seq[String]): File]]",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@huntc - is there a way to reference overloaded method in Scaladoc? This doesn't seem to come out right.

Copy link
Contributor

Choose a reason for hiding this comment

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

dunno

…patibility with 1.0.4

The methods in question are the methods used to create various kinds of archives (e.g. zip or tar)
from `com.typesafe.sbt.packager.universal.Archives`
@fsat fsat force-pushed the deprecate-old-archives-methods branch from 94c696c to ce7cc54 Compare September 10, 2015 05:41
@muuki88 muuki88 added the universal Zip, tar.gz, tgz and bash issues label Sep 10, 2015
muuki88 added a commit that referenced this pull request Sep 10, 2015
WIP - DON'T MERGE - Reinstate and deprecate older methods to preserve binary backward compatibility with 1.0.4
@muuki88 muuki88 merged commit 1305e89 into sbt:master Sep 10, 2015
@muuki88
Copy link
Contributor

muuki88 commented Sep 10, 2015

1.0.5-M2 is out

@fsat fsat changed the title WIP - DON'T MERGE - Reinstate and deprecate older methods to preserve binary backward compatibility with 1.0.4 Reinstate and deprecate older methods to preserve binary backward compatibility with 1.0.4 Sep 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
universal Zip, tar.gz, tgz and bash issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants