Skip to content

Commit

Permalink
Initial cut at the Scala-specific doc guide (won't be linked to until…
Browse files Browse the repository at this point in the history 
… we ship JVM languages support)
  • Loading branch information
@michaelklishin
michaelklishin committed Jan 28, 2012
1 parent a3f1eaa commit 5aea159
Show file tree
Hide file tree
Showing 2 changed files with 198 additions and 0 deletions.
151 changes: 151 additions & 0 deletions docs/user/languages/scala/index.html
View file
@@ -0,0 +1,151 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Travis CI: Building a Scala project</title>
<link rel="stylesheet" type="text/css" href="/style.css" media="screen">
<link rel="alternate" type="application/rss+xml" href="/blog.xml">
</head>
<body>
<div id="navigation">
<div class="wrapper">
<a href="http://travis-ci.org" id="logo">travis-ci<span>.org</span></a>
<ul>
<li><a href="/blog/">Blog</a></li>
<li><a href="/docs/">Documentation</a></li>
<li class="english lang active"><a href="/" class="selected">English</a></li>
<li class="french lang"><a href="/fr/">Français</a></li>
</ul>
</div>
</div>

<div id="header">
<div class="wrapper">
<h1 class="riddle"><a href="/" title="Travis">Travis CI</a></h1>
<p>A distributed build system for the open source community.</p>
</div><!-- /.wrapper -->
</div><!-- /#header -->

<div id="content">
<div class="wrapper">
<div class="pad">
<div id="main">

<h2>Building a Scala project</h2>


<h2 id="what-this-guide-covers">What This Guide Covers</h2>

<p>This guide covers build environment and configuration topics specific to Scala projects. Please make sure to read our <a href="/docs/user/getting-started/">Getting Started</a> and <a href="/docs/user/build-configuration/">general build configuration</a> guides first.</p>

<h2 id="choosing-scala-versions-to-test-against">Choosing Scala versions to test against</h2>

<p>Travis Scala VMs provide SBT 0.11.x and OpenJDK 6. Thanks to SBT 0.11.x ability to perform actions against multiple Scala versions,
it is possible to test your projects against Both Scala 2.8.x and 2.9.x.
To specify Scala versions you want your project to be tested against, use the <code>scala</code> key:</p>

<pre><code>language: scala
scala:
- 2.8.2
- 2.9.1
</code></pre>

<h2 id="default-test-command">Default Test Command</h2>

<p>Travis CI by default assumes your project is built using SBT. The exact command Scala builder
will use by default is</p>

<pre><code>sbt +$SCALA_VERSION test
</code></pre>

<p>if your project has <code>project</code> directory or <code>build.sbt</code> file in the repository root. If this is not the case, Scala builder will fall back to</p>

<pre><code>mvn test
</code></pre>

<h2 id="dependency-management">Dependency Management</h2>

<p>Because Scala builder on travis-ci.org assumes SBT dependency management is used by default, it naturally will pull down project
dependencies before running tests without any effort on your side.</p>

<h3 id="examples">Examples</h3>

<ul>
<li><a href="https://github.com/gildegoma/salat/blob/add-travis-ci/.travis.yml">gildegoma/salat</a></li>
</ul>

</div><!-- /#main -->
<div id="sidebar">
<h2>Contact</h2>
<ul>
<li><a href="http://github.com/travis-ci">Github</a></li>
<li><a href="http://twitter.com/travisci">Twitter</a></li>
<li><a href="irc://irc.freenode.net#travis">IRC</a></li>
<li><a href="http://groups.google.com/group/travis-ci">Mailing list</a></li>
</ul>
<h2>Guides</h2>
<ul>
<li><a href="/docs/user/getting-started/">Getting started</a></li>
<li><a href="/docs/user/build-configuration/">Build configuration</a></li>
<li><a href="/docs/user/database-setup/">Database setup</a></li>
<li><a href="/docs/user/selenium-setup/">Headless browser setup</a></li>
<li><a href="/docs/user/status-images/">Build Status images</a></li>
<li><a href="/docs/user/ci-environment/">CI environment</a></li>
</ul>
<h2>Language-specific Guides</h2>
<ul>
<li><a href="/docs/user/languages/clojure/">Clojure</a></li>
<li><a href="/docs/user/languages/erlang/">Erlang</a></li>
<li><a href="/docs/user/languages/javascript-with-nodejs/">JavaScript (with Node.js)</a></li>
<li><a href="/docs/user/languages/php/">PHP</a></li>
<li><a href="/docs/user/languages/ruby/">Ruby</a></li>
</ul>

<h2>3rd Party Tools and Resources</h2>
<ul>
<li><a href="/docs/user/browser-extensions/">Browser Extensions</a></li>
<li><a href="/docs/user/resources/">Links & Resources</a></li>
</ul>

<h2>How-Tos</h2>
<ul>
<li><a href="/docs/user/how-to-skip-a-build/">How to skip a build</a></li>
<li><a href="/docs/user/how-to-setup-and-trigger-the-hook-manually/">How to setup GitHub Travis hook and trigger builds manually</a></li>
</ul>
<h2>Developer Guides</h2>
<ul>
<li><a href="/docs/dev/api/">The API</a></li>
</ul>
<h2>Contributor Guides</h2>
<ul>
<li><a href="/docs/dev/overview/">Technical Overview</a></li>
<li><a href="/docs/dev/worker/">The worker (v3)</a></li>
<li><a href="/docs/dev/build_tasks/">Build Tasks</a></li>
<li><a href="/docs/dev/maintenance/">Maintenance</a></li>
</ul>
<h2>Contributing</h2>
<p>This documentation site is open source. Feel free to <a href="https://github.com/travis-ci/travis-ci.github.com/issues">file issues about it</a>.
To contribute, see <a href="https://github.com/travis-ci/travis-ci.github.com">Git repository</a> and join travis#irc.freenode.net to discuss your changes.</p>
</div><!-- /#sidebar -->
</div><!-- /.pad -->
</div><!-- /.wrapper -->
</div><!-- /#content -->

<div id="footer">
<div class="wrapper">
<div class="box">
<p>This site is maintained by the <a href="http://github.com/travis-ci">Travis CI community</a>. Feel free to <a href="http://github.com/travis-ci/travis-ci.github.com">contribute</a>!</p>
</div>
<div class="box">
<p>This design was kindly provided by the talented Ben Webster of <a href="http://www.plus2.com.au">Plus2</a>.</p>
</div>
<div class="box last">
<ul>
<li><a href="https://github.com/travis-ci" title="">Travis CI on GitHub</a></li>
<li><a href="https://twitter.com/travisci" title="">Travis CI on Twitter</a></li>
</ul>
</div><!-- /.box -->
</div><!-- /.wrapper -->
</div><!-- /#footer -->
</body>
</html>
47 changes: 47 additions & 0 deletions source/content/docs/user/languages/scala.md
View file
@@ -0,0 +1,47 @@
---
title: Building a Scala project
kind: content
---

## What This Guide Covers

This guide covers build environment and configuration topics specific to Scala projects. Please make sure to read our [Getting Started](/docs/user/getting-started/) and [general build configuration](/docs/user/build-configuration/) guides first.


## Choosing Scala versions to test against

Travis Scala VMs provide SBT 0.11.x and OpenJDK 6. Thanks to SBT 0.11.x ability to perform actions against multiple Scala versions,
it is possible to test your projects against Both Scala 2.8.x and 2.9.x.
To specify Scala versions you want your project to be tested against, use the `scala` key:

language: scala
scala:
- 2.8.2
- 2.9.1



## Default Test Command

Travis CI by default assumes your project is built using SBT. The exact command Scala builder
will use by default is

sbt +$SCALA_VERSION test

if your project has `project` directory or `build.sbt` file in the repository root. If this is not the case, Scala builder will fall back to

mvn test




## Dependency Management

Because Scala builder on travis-ci.org assumes SBT dependency management is used by default, it naturally will pull down project
dependencies before running tests without any effort on your side.



### Examples

* [gildegoma/salat](https://github.com/gildegoma/salat/blob/add-travis-ci/.travis.yml)

0 comments on commit 5aea159

Please sign in to comment.