Merge pull request #3936 from eed3si9n/wip/notes

sbt 1.1.1 notes
This commit is contained in:
eugene yokota 2018-02-09 23:36:05 -05:00 committed by GitHub
commit 2c0b953321
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 49 additions and 59 deletions

View File

@ -9,7 +9,7 @@ def buildLevelSettings: Seq[Setting[_]] =
inThisBuild(
Seq(
organization := "org.scala-sbt",
version := "1.1.1-SNAPSHOT",
version := "1.1.2-SNAPSHOT",
description := "sbt is an interactive build tool",
bintrayOrganization := Some("sbt"),
bintrayRepository := {

45
notes/1.1.1.markdown Normal file
View File

@ -0,0 +1,45 @@
### Fixes
- Fixes "Modified names for (class) is empty" error. [zinc#292][zinc292] / [zinc#484][zinc484] by [@jvican][@jvican]
- Fixes tab completion in `console` while running in batch mode as `sbt console`. [#3841][3841]/[#3876][3876] by [@eed3si9n][@eed3si9n]
- Fixes file timestamp retrieval of missing files on Windows. [#3871][3871] / [io#120][io120] by [@cunei][@cunei]
- Aligns the errors thrown by file timestamp implementations. Fixes [#3894][3894] / [io#121][io121] by [@j-keck][@j-keck]
- Adds file timestamps native support for FreeBSD. [#3894][3894] / [io#124][io124] by [@cunei][@cunei]
- Fixes JDK 10 version string parsing. [launcher#209][launcher209] by [@2m][@2m]
### Improvements
- Deprecates `Extracted#append` in favour of `appendWithSession` or `appendWithoutSession`. [#3865][3865] by [@dwijnand][@dwijnand]
- Adds a new global `Boolean` setting called `autoStartServer`. See below.
- Upgrades Scala versions used for sbt cross building `^^`. [#3923][3923] by [@dwijnand][@dwijnand]
- Many documentation maintenance changes by [@xuwei-k][@xuwei-k]
### autoStartServer setting
sbt 1.1.1 adds a new global `Boolean` setting called `autoStartServer`, which is set to `true` by default.
When set to `true`, sbt shell will automatically start sbt server. Otherwise, it will not start the server until `startSever` command is issued. This could be used to opt out of server for security reasons.
[#3922][3922] by [@swaldman][@swaldman]
[@eed3si9n]: https://github.com/eed3si9n
[@dwijnand]: http://github.com/dwijnand
[@cunei]: https://github.com/cunei
[@jvican]: https://github.com/jvican
[@Duhemm]: https://github.com/Duhemm
[@j-keck]: https://github.com/j-keck
[@swaldman]: https://github.com/swaldman
[@xuwei-k]: https://github.com/xuwei-k
[@2m]: https://github.com/2m
[3871]: https://github.com/sbt/sbt/issues/3871
[io120]: https://github.com/sbt/io/pull/120
[3894]: https://github.com/sbt/sbt/issues/3894
[io121]: https://github.com/sbt/io/pull/121
[io124]: https://github.com/sbt/io/pull/124
[zinc292]: https://github.com/sbt/zinc/issues/292
[zinc484]: https://github.com/sbt/zinc/pull/484
[3865]: https://github.com/sbt/sbt/pull/3865
[3841]: https://github.com/sbt/sbt/issues/3841
[3876]: https://github.com/sbt/sbt/pull/3876
[3923]: https://github.com/sbt/sbt/pull/3923
[3922]: https://github.com/sbt/sbt/pull/3922
[launcher209]: https://github.com/sbt/sbt-launcher-package/pull/209

View File

@ -1,31 +0,0 @@
### Improvements
This pull request implements a Boolean setting called `autoStartServer`, whose default value is `true'.
If a build or plugin explicitly sets it to `false`, the sbt-1.x server will not start up
(exactly as if the system property `sbt.server.autostart` were set to `false`).
Users who set `autoStartServer` to `false` may manually execute `startServer` at the interactive prompt,
if they wish to use the server during a shell session.
### Motivation
Projects often encounter private information, such as deployment credentials, private keys, etc.
For such projects, it may be preferable to reduce the potential attack surface than to enjoy the
interoperability offered by sbt's server. Projects that wish to make this tradeoff can set `autoStartServer`
to `false` in their build. Security-sensitive plugins can disable `autoStartServer` as well, modifying the
default behavior in favor of security.
(My own motivation is that I am working on a [plugin for developing Ethereum applications](https://github.com/swaldman/sbt-ethereum)
with scala and sbt. It must work with extremely sensitive private keys.)
---
See also a [recent conversation on Stack Exchange](https://stackoverflow.com/questions/48591179/can-one-disable-the-sbt-1-x-server/48593906#48593906).
---
##### History
2018-02-06 Modified from negative `suppressServer` to positive `autoStartServer` at the (sensible) request of @eed3si9n

View File

@ -1,13 +0,0 @@
[@eed3si9n]: https://github.com/eed3si9n
[3841]: https://github.com/sbt/sbt/issues/3841
[3876]: https://github.com/sbt/sbt/pull/3876
### Fixes with compatibility implications
### Improvements
### Bug fixes
- Fixes tab completion in `console` while running in batch mode as `sbt console`. [#3841][3841]/[#3876][3876] by [@eed3si9n][@eed3si9n]

View File

@ -1,11 +0,0 @@
[@dwijnand]: https://github.com/dwijnand
[#3865]: https://github.com/sbt/sbt/pull/3865
### Fixes with compatibility implications
### Improvements
- Deprecates `Extracted#append` in favour of `appendWithSession` or `appendWithoutSession`. [#3865][] by [@dwijnand][]
### Bug fixes

View File

@ -4,7 +4,7 @@
[app]
org: ${sbt.organization-org.scala-sbt}
name: sbt
version: ${sbt.version-read(sbt.version)[1.1.0]}
version: ${sbt.version-read(sbt.version)[1.1.1]}
class: sbt.ScriptMain
components: xsbti,extra
cross-versioned: ${sbt.cross.versioned-false}

View File

@ -4,7 +4,7 @@
[app]
org: ${sbt.organization-org.scala-sbt}
name: sbt
version: ${sbt.version-read(sbt.version)[1.1.0]}
version: ${sbt.version-read(sbt.version)[1.1.1]}
class: sbt.ConsoleMain
components: xsbti,extra
cross-versioned: ${sbt.cross.versioned-false}

View File

@ -4,7 +4,7 @@
[app]
org: ${sbt.organization-org.scala-sbt}
name: sbt
version: ${sbt.version-read(sbt.version)[1.1.0]}
version: ${sbt.version-read(sbt.version)[1.1.1]}
class: sbt.xMain
components: xsbti,extra
cross-versioned: ${sbt.cross.versioned-false}