luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sbt, the interactive build tool
2,202 Commits 29 Branches 309 Tags 68 MiB
Scala 94.5%
Java 3.1%
Shell 1.1%
Batchfile 0.9%
Roff 0.2%
Other 0.1%
Go to file
Mark Harrah a9289ad0ce Explicitly specify type parameters in calls to KCons in KList builder. 
scalac couldn't infer the type constructor otherwise.
 		2012-11-18 09:20:26 -05:00
cache lazy InputCache for recursive caches 2011-06-20 15:25:23 -04:00
compile task setting macros for :=, +=, ++= 2012-11-17 20:19:24 -05:00
interface API extraction: handle any type that is annotated, not just the spec'd simple type. Fixes #559. 2012-10-05 09:06:35 -04:00
ivy Resolve Scala version for projects in the normal `update` task. 2012-11-17 20:23:06 -05:00
launch 2.10.0-M5, different arity generalization 2012-11-17 20:19:24 -05:00
licenses move remaining pieces of sbt subproject to sbt_pending and fix notices 2010-09-21 21:55:50 -04:00
main Explicitly specify type parameters in calls to KCons in KList builder. 2012-11-18 09:20:26 -05:00
project bump to Scala 2.10.0-RC2 2012-11-18 09:18:22 -05:00
run Prevent 'radio silence' for ForkRun.run(). 2011-11-10 15:47:25 +05:30
sbt workaround for https://issues.scala-lang.org/browse/SI-6662 2012-11-17 20:23:07 -05:00
sbt_pending drop more migrated pending items 2011-04-20 18:31:37 -04:00
scripted InputTask macro 2012-11-17 20:23:07 -05:00
src Docs: Working with macros. Closes #573. 2012-11-12 21:20:52 -05:00
tasks 2.10.0-M5, different arity generalization 2012-11-17 20:19:24 -05:00
testing Use java.lang.Throwable.setStackTrace. Proper fix for #543. 2012-11-15 10:14:59 -05:00
util Explicitly specify type parameters in calls to KCons in KList builder. 2012-11-18 09:20:26 -05:00
.gitignore doc updates, conversions, howto extension, theme from akka 2012-09-30 20:36:38 -04:00
LICENSE * move Environment classes to util/env module 2010-07-14 19:24:50 -04:00
NOTICE * move Environment classes to util/env module 2010-07-14 19:24:50 -04:00
README.md update links in README to point to scala-sbt.org. Fixes #567. 2012-10-10 08:30:40 -04:00
api.specification Macro def aware recompilation. 2012-03-04 17:35:51 +01:00
launch.specification XSBT-5: maven-style ivy repo support in the launcher config 2012-10-29 09:04:42 -04:00
scripted.specification New scripted test framework 2009-11-09 09:34:52 -05:00

README.md

sbt 0.13

This is the 0.13.x series of sbt.

  • Setup: Describes getting started with the latest binary release. See below to build from source.
  • FAQ: Explains how to get help, how to report an issue, and how to contribute.
  • There is a video of a demo given at Scala Days 2011 based on sbt 0.10.0 that gives an introduction to the configuration system in sbt 0.10.0 and later. See the documentation for current information.
  • Google Code: hosts sbt 0.7.7 and earlier versions

Build from source

  1. Install the current stable binary release of sbt (see Setup), which will be used to build sbt from source.

  2. Get the source code.

     $ git clone git://github.com/harrah/xsbt.git
 $ cd xsbt

  3. The initial branch is the development branch 0.13, which contains the latest code for the next major sbt release. To build a specific release or commit, switch to the associated tag. The tag for the latest stable release is v0.12.1:

     $ git checkout v0.12.1

    Note that sbt is always built with the previous stable release. For example, the 0.13 branch is built with 0.12.1, the v0.11.2 tag is built with 0.11.1, and the v0.11.0 tag is built with 0.10.1.

  4. To build the launcher, publish all components locally, and build API and SXR documentation:

     $ sbt build-all

    Alternatively, the individual commands run by build-all may be executed directly:

     $ sbt publish-local proguard sxr doc

  5. To use this locally built version of sbt, copy your stable ~/bin/sbt script to ~/bin/xsbt and change it to use the launcher jar in <xsbt>/target/. For the v0.12.1 tag, the full location is:

     <xsbt>/target/sbt-launch-0.12.1.jar

    If using the 0.13 development branch, the launcher is at:

     <xsbt>/target/sbt-launch-0.13.0-SNAPSHOT.jar

Modifying sbt

  1. New development takes place on the 0.13 branch. Fixes and improvements that are binary compatible with 0.12 can be backported to the 0.12 branch at the time of the next release.

  2. When developing sbt itself, there is no need to run build-all, since this generates documentation as well. For the fastest turnaround time for checking compilation only, run compile.

  3. To use your modified version of sbt in a project locally, run publish-local. If you have modified the launcher, also run proguard.

  4. After each publish-local, clean the ~/.sbt/boot/ directory. Alternatively, if sbt is running and the launcher hasn't changed, run reboot full to have sbt do this for you.

  5. If a project has project/build.properties defined, either delete the file or change sbt.version to 0.13.0-SNAPSHOT.

Building Documentation

Documentation is built using sphinx and requires some external programs and libraries to be manually installed first:

$ pip install pygments
$ pip install sphinx
$ pip install sphinxcontrib-issuetracker

To build the full site, run the make-site task, which will generate the manual, API, SXR, and other site pages in target/site/. To only work on the site and not API or SXR, run sphinx:mappings.