diff --git a/notes/0.13.13.markdown b/notes/0.13.13.markdown new file mode 100644 index 000000000..e4506ecbd --- /dev/null +++ b/notes/0.13.13.markdown @@ -0,0 +1,126 @@ + +### Fixes with compatibility implications + +- Deprecates the old symbolic operators, to be removed in sbt 1.0. See below for more details. +- The `.value` method is deprecated for input tasks. Calling `.value` on an input key returns an `InputTask[A]`, + which is completely unintuitive and often results in a bug. In most cases `.evaluated` should be called, + which returns `A` by evaluating the task. + Just in case `InputTask[A]` is needed, `.inputTaskValue` method is now provided. [#2709][2709] by [@eed3si9n][@eed3si9n] +- sbt 0.13.13 renames the early command `--` that was added in 0.13.1 to `early()`. This fixes the regression [#1041][1041]. For backward compatibility `--error`, `--warn`, `--info`, and `--debug` will continue to function during the 0.13 series, but it is strongly encouraged to migrate to the single hyphen options: `-error`, `-warn`, `-info`, and `-debug`. [#2742][2742] by [@eed3si9n][@eed3si9n] + +### Improvements + +- Adds `new` command and `templateResolvers`. See below for more details. +- Auto plugins can add synthetic subprojects. See below for more details. +- Supports wildcard exclusions in POMs [#1431][1431]/[sbt/ivy#22][sbt-ivy-22]/[#2731][2731] by [@jtgrabowski][@jtgrabowski] +- Adds the ability to call `aggregateProjects(..)` for the current project inside a build sbt file. [#2682][2682] by [@xuwei-k][@xuwei-k] +- Adds `.jvmopts` support to the launcher script. [sbt/sbt-launcher-package#111][111] by [@fommil][@fommil] +- Adds `.java-version` support to the Windows launcher script. [sbt/sbt-launcher-package#111][111] by [@fommil][@fommil] + + +### Bug fixes + +- Fixes a regression in sbt 0.13.12 that wrongly reports build-level keys to be ambiguous. [#2707][2707]/[#2708][2708] by [@Duhemm][@Duhemm] +- Fixes forked tests being reported as successful when the test harness fails. [#2442][2442]/[#2722][2722]/[#2730][2730] by [@eed3si9n][@eed3si9n]/[@dwijnand][@dwijnand] +- Fixes incorrect installation path on Windows. [sbt/sbt-launcher-package#110][110] by [@dwijnand][@dwijnand] + +### new command and templateResolvers + +sbt 0.13.13 adds a `new` command, which helps create new build definitions. +The `new` command is extensible via a mechanism called the template resolver, +which evaluates the arguments passed to the command to find and run a template. +As a reference implementation [Giter8][g8] is provided. For instance: + + sbt new eed3si9n/hello.g8 + +will run [eed3si9n/hello.g8][] using Giter8. + +[#2705][2705] by [@eed3si9n][@eed3si9n] + +### Synthetic subprojects + +sbt 0.13.13 adds support for `AutoPlugin`s to define subprojects programmatically, +by overriding the `extraProjects` method: + + import sbt._, Keys._ + + object ExtraProjectsPlugin extends AutoPlugin { + override def extraProjects: Seq[Project] = + List("foo", "bar", "baz") map generateProject + + def generateProject(id: String): Project = + Project(id, file(id)). + settings( + name := id + ) + } + +In addition, subprojects may be derived from an existing subproject +by overriding `derivedProjects`: + + import sbt._, Keys._ + + object DerivedProjectsPlugin extends AutoPlugin { + // Enable this plugin by default + override def requires: Plugins = sbt.plugins.CorePlugin + override def trigger = allRequirements + + override def derivedProjects(proj: ProjectDefinition[_]): Seq[Project] = + // Make sure to exclude project extras to avoid recursive generation + if (proj.projectOrigin != ProjectOrigin.DerivedProject) { + val id = proj.id + "1" + Seq( + Project(id, file(id)). + enablePlugins(DatabasePlugin) + ) + } + else Nil + } + +[#2532][2532]/[#2717][2717]/[#2738][2738] by [@eed3si9n][@eed3si9n] + +### Deprecate old operators + +The no-longer-documented operators `<<=`, `<+=`, and `<++=` are deprecated, +and will be removed in sbt 1.0. + +For `<<=`, the suggested migration would be to use either `:=` or `~=` operators. +The RHS of `<<=` takes an `Initialize[_]` expression, which can be converted to `:=` style +by wrapping the expression in parenthesis, and calling `.value` at the end. +For example: + + key := (key.dependsOn(compile in Test)).value + +For `<+=` and `<++=`, use `+= { x.value }` and `++= { x.value }`. + +[#2716][2716] by [@eed3si9n][@eed3si9n] + + [g8]: http://www.foundweekends.org/giter8/ + [eed3si9n/hello.g8]: https://github.com/eed3si9n/hello.g8 + + [1041]: https://github.com/sbt/sbt/issues/1041 + [1431]: https://github.com/sbt/sbt/issues/1431 + [2442]: https://github.com/sbt/sbt/issues/2442 + [2532]: https://github.com/sbt/sbt/issues/2532 + [2705]: https://github.com/sbt/sbt/pull/2705 + [2682]: https://github.com/sbt/sbt/pull/2682 + [2707]: https://github.com/sbt/sbt/issues/2707 + [2708]: https://github.com/sbt/sbt/issues/2708 + [2709]: https://github.com/sbt/sbt/pull/2709 + [2716]: https://github.com/sbt/sbt/pull/2716 + [2717]: https://github.com/sbt/sbt/pull/2717 + [2722]: https://github.com/sbt/sbt/issues/2722 + [2730]: https://github.com/sbt/sbt/pull/2730 + [2731]: https://github.com/sbt/sbt/pull/2731 + [2738]: https://github.com/sbt/sbt/issues/2738 + [2742]: https://github.com/sbt/sbt/pull/2742 + [110]: https://github.com/sbt/sbt-launcher-package/pull/110 + [111]: https://github.com/sbt/sbt-launcher-package/pull/111 + [sbt-ivy-22]: https://github.com/sbt/ivy/pull/22 + + [@eed3si9n]: https://github.com/eed3si9n + [@dwijnand]: https://github.com/dwijnand + [@Duhemm]: https://github.com/Duhemm + [@xuwei-k]: https://github.com/xuwei-k + [@jtgrabowski]: https://github.com/jtgrabowski + [@fommil]: https://github.com/fommil diff --git a/notes/0.13.13/aggregate-build-sbt.md b/notes/0.13.13/aggregate-build-sbt.md deleted file mode 100644 index ef459e2e9..000000000 --- a/notes/0.13.13/aggregate-build-sbt.md +++ /dev/null @@ -1,5 +0,0 @@ - [@xuwei-k]: https://github.com/xuwei-k - -### Improvements - -- Add the ability to call aggregate for the current project inside a build sbt file. By [@xuwei-k][@xuwei-k] diff --git a/notes/0.13.13/early.md b/notes/0.13.13/early.md deleted file mode 100644 index 501720e14..000000000 --- a/notes/0.13.13/early.md +++ /dev/null @@ -1,6 +0,0 @@ -### Fixes with compatibility implications - -- sbt 0.13.13 renames the early command that was added in 0.13.1 to `early()`. This fixes the regression [#1041][1041]. For backward compatibility `--error`, `--warn`, `--info`, and `--debug` will continue to function during 0.13 series, but it is strongly encouraged to migrate to the single hyphen option: `-error`, `-warn`, `-info`, and `-debug`. [@eed3si9n][@eed3si9n] - - [1041]: https://github.com/sbt/sbt/issues/1041 - [@eed3si9n]: https://github.com/eed3si9n diff --git a/notes/0.13.13/extras.md b/notes/0.13.13/extras.md deleted file mode 100644 index 1ad735597..000000000 --- a/notes/0.13.13/extras.md +++ /dev/null @@ -1,43 +0,0 @@ - -### Synthetic subprojects - -sbt 0.13.13 adds support for `AutoPlugin`s to generate -synthetic subprojects. To generate subprojects, override `extraProjects` -method as follows: - - import sbt._ - import Keys._ - - object ExtraProjectPluginExample extends AutoPlugin { - override def extraProjects: Seq[Project] = - List("foo", "bar", "baz") map generateProject - - def generateProject(id: String): Project = - Project(id, file(id)). - settings( - name := id - ) - } - -In addition, subprojects may be derived from an existing subproject -by overriding `derivedProjects`. - - import sbt._ - import Keys._ - - object ExtraProjectPluginExample2 extends AutoPlugin { - // Enable this plugin by default - override def requires: Plugins = sbt.plugins.CorePlugin - override def trigger = allRequirements - - override def derivedProjects(proj: ProjectDefinition[_]): Seq[Project] = - // Make sure to exclude project extras to avoid recursive generation - if (proj.projectOrigin != ProjectOrigin.DerivedProject) { - val id = proj.id + "1" - Seq( - Project(id, file(id)). - enablePlugins(DatabasePlugin) - ) - } - else Nil - } diff --git a/notes/0.13.13/fix-key-selection-for-build-level-keys.md b/notes/0.13.13/fix-key-selection-for-build-level-keys.md deleted file mode 100644 index 95916d6d2..000000000 --- a/notes/0.13.13/fix-key-selection-for-build-level-keys.md +++ /dev/null @@ -1,11 +0,0 @@ - [@Duhemm]: https://github.com/Duhemm - [#2707]: https://github.com/sbt/sbt/issues/2707 - [#2708]: https://github.com/sbt/sbt/issues/2708 - -### Fixes with compatibility implications - -### Improvements - -### Bug fixes - -- Fix key selection for build level keys. sbt wrongly reported some keys as ambiguous. Fixes [#2707][#2707]. [#2708][#2708] by [@Duhemm][@Duhemm] diff --git a/notes/0.13.13/fork_test.md b/notes/0.13.13/fork_test.md deleted file mode 100644 index 4029c6b3c..000000000 --- a/notes/0.13.13/fork_test.md +++ /dev/null @@ -1,8 +0,0 @@ -### Bug fixes - -- Fixes forked test succeeding when the test harness fails. [#2442][2442]/[#2730][2730] by [@eed3si9n][@eed3si9n]/[@dwijnand][@dwijnand} - - [2442]: https://github.com/sbt/sbt/issues/2442 - [2730]: https://github.com/sbt/sbt/pull/2730 - [@eed3si9n]: https://github.com/eed3si9n - [@dwijnand]: https://github.com/dwijnand diff --git a/notes/0.13.13/inputtask_value.md b/notes/0.13.13/inputtask_value.md deleted file mode 100644 index b91e4a94c..000000000 --- a/notes/0.13.13/inputtask_value.md +++ /dev/null @@ -1,10 +0,0 @@ - -### Fixes with compatibility implications - -- `.value` method is deprecated for input tasks. Calling `.value` method on an input task returns `InputTask[A]`, - which is completely unintuitive and often results to a bug. In most cases `.evaluated` should be called, - which returns `A` by evaluating the task. - Just in case `InputTask[A]` is needed, `inputTaskValue` method is now provided. [#2709][2709] by [@eed3si9n][@eed3si9n] - - [@eed3si9n]: https://github.com/eed3si9n - [2709]: https://github.com/sbt/sbt/pull/2709 diff --git a/notes/0.13.13/maven-plugin-transitive-wildcard-excludes.markdown b/notes/0.13.13/maven-plugin-transitive-wildcard-excludes.markdown deleted file mode 100644 index be0cd68a7..000000000 --- a/notes/0.13.13/maven-plugin-transitive-wildcard-excludes.markdown +++ /dev/null @@ -1,12 +0,0 @@ -[@jtgrabowski]: https://github.com/jtgrabowski -[1431]: https://github.com/sbt/sbt/issues/1431 -[sbt-ivy-22]: https://github.com/sbt/ivy/pull/22 -[2731]: https://github.com/sbt/sbt/pull/2731 - -### Fixes with compatibility implications - -### Improvements - -### Bug fixes - -- Support wildcard exclusions when using sbt-maven-resolver-plugin [#1431][1431][sbt/ivy#22][sbt-ivy-22]/[#2731][2731] by [@jtgrabowski][@jtgrabowski] diff --git a/notes/0.13.13/ops_deprecation.md b/notes/0.13.13/ops_deprecation.md deleted file mode 100644 index b58f005f0..000000000 --- a/notes/0.13.13/ops_deprecation.md +++ /dev/null @@ -1,21 +0,0 @@ - -### Fixes with compatibility implications - -- Deprecate old operators. - -### Deprecate old operators - -The no-longer-documented operators `<<=`, `<+=`, and `<++=` are deprecated, -and will be removed in sbt 1.0. - -For `<<=`, the suggested migration would be to use either `:=` or `~=` operators. -The RHS of `<<=` takes an `Initialize[_]` expression, which can be converted to `:=` style -by wrapping the expression in parenthesis, and calling `.value` at the end. -For example: - - key := (key.dependsOn(compile in Test)).value - -For `<+=` and `<++=`, use `+= { x.value }` and `++= { x.value }`. - - [@eed3si9n]: https://github.com/eed3si9n - diff --git a/notes/0.13.13/template_cmd.md b/notes/0.13.13/template_cmd.md deleted file mode 100644 index 31e755a4b..000000000 --- a/notes/0.13.13/template_cmd.md +++ /dev/null @@ -1,14 +0,0 @@ - -### new command and templateResolvers - -sbt 0.13.13 adds `new` command, which helps create a new build definition. -The `new` command is extensible via a mechanism called the template resolver, -which evaluates the arguments passed to the command to find and run a template. -As a reference implementation [Giter8][g8] is provided as follows: - - sbt new eed3si9n/hello.g8 - -This will run eed3si9n/hello.g8 using Giter8. - - [@eed3si9n]: https://github.com/eed3si9n - [g8]: http://www.foundweekends.org/giter8/