Permalink
Browse files

add some docs and temporarily move hardcode the blog post to the home…

…page
  • Loading branch information...
1 parent ef6ab37 commit e9cfea5fc59c96375baa758ffcc4a6665e330887 Sven Fuchs committed Jul 21, 2011
@@ -34,7 +34,7 @@ <h2>Welcome to Travis CI</h2>
<p>Travis CI is an open-source, distributed build system for the Ruby community.</p>
-<p>We are going to blog more about it later but for now you can read up on the initial ideas on <a href="http://svenfuchs.com/2011/2/5/travis-a-distributed-build-server-tool-for-the-ruby-community">Sven’s blog</a> and flip through <a href="http://talk-2011-lyon.heroku.com">a presentation</a> that we gave at 3 conferences and 2 Ruby user groups this summer.</p>
+<p>We are going to blog more about it later but for now you can read up on the <em>initial ideas</em> on <a href="http://svenfuchs.com/2011/2/5/travis-a-distributed-build-server-tool-for-the-ruby-community">Sven’s blog</a> and flip through <a href="http://talk-2011-lyon.heroku.com">a presentation</a> that we gave at 3 conferences and 2 Ruby user groups this summer.</p>
<p>If you feel like this is a great project then jump into <a href="irc://travis#irc.freenode.net">#travis on irc.freenode.net</a> and say hi!</p>
@@ -49,8 +49,8 @@ <h2>Contact</h2>
</ul>
<h2>Documentation</h2>
<ul>
- <li><a href="#">Getting started</a></li>
- <li><a href="#">Build configuration</a></li>
+ <li><a href="/docs/getting-started">Getting started</a></li>
+ <li><a href="/docs/build-configuration">Build configuration</a></li>
</ul>
<h2>Under construction</h2>
<ul>
@@ -0,0 +1,198 @@
+<!DOCTYPE HTML>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Travis CI: About - Build Configuration</title>
+ <link rel="stylesheet" type="text/css" href="/style.css" media="screen">
+ </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</a></li>
+ <li><a href="/docs/">Docs</a></li>
+ <li class="right"><a href="http://travis-ci.org">go to travis-ci.org &rarr;</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div id="header">
+ <div class="wrapper">
+ <h1 class="riddle"><a href="/" title="Travis">Travis CI</a></h1>
+ <p>An open-source, distributed build system for the Ruby community.</p>
+ </div><!-- /.wrapper -->
+ </div><!-- /#header -->
+
+ <div id="content">
+ <div class="wrapper">
+ <div class="pad">
+ <div id="main">
+
+ <h2>Build Configuration</h2>
+
+
+ <p>The <code>.travis.yml</code> file in the root of your repo allows you configure your builds. Travis CI will always look for the <code>.travis.yml</code> file that is contained in the SHA/commit that Github has passed.</p>
+
+<p>Below are some of the configuration options and a brief explanation of what is achieved using them.</p>
+
+<h3>Specify a Ruby version</h3>
+
+<p>To specify a particular Ruby version to test against you can do:</p>
+
+<pre><code>rvm: rbx
+</code></pre>
+
+<h3>Specify a Gemfile</h3>
+
+<p>To specify a custom Gemfile variable you can do:</p>
+
+<pre><code>gemfile: gemfiles/Gemfile.ci
+</code></pre>
+
+<h3>Set an environment variable</h3>
+
+<p>To specify a single environment variable you can do:</p>
+
+<pre><code>env: RAILS_ENV=test
+</code></pre>
+
+<h3>Specify a build matrix</h3>
+
+<p>You can also combine the three configuration options above and configure Travis CI to run your tests against a matrix of various configurations. There are 3 matrix dimensions supported:</p>
+
+<ul>
+ <li><code>rvm</code> - specify Ruby versions to test against</li>
+ <li><code>gemfile</code> - specify different dependencies to test against</li>
+ <li><code>env</code> - specify different environment variables to be set, so you can configure various things in your build script based on this</li>
+</ul>
+
+<p>Below is an example configuration for a rather big build matrix that expands to 32 individual builds.</p>
+
+<p>Please take into account that Travis CI is an open source service and we need to rely on worker boxes provided by the community. So please only specify an as big matrix as you actually really need.</p>
+
+<pre><code>rvm:
+ - 1.8.7 # (current default)
+ - 1.9.2
+ - rbx
+ - rbx-2.0
+ - ree
+ - jruby
+ - ruby-head
+ - 1.8.6
+gemfile:
+ - gemfiles/Gemfile.rails-2.3.x
+ - gemfiles/Gemfile.rails-3.0.x
+env:
+ - ISOLATED=true
+ - ISOLATED=false
+</code></pre>
+
+<h3>Define a custom build script</h3>
+
+<p>Define how to run your tests (defaults to <code>bundle exec rake</code> or <code>rake</code> depending on whether you have a <code>Gemfile</code>).</p>
+
+<pre><code>script: "bundle exec rake db:drop db:create db:migrate test"
+</code></pre>
+
+<h3>Set bundler args</h3>
+
+<p>Define tasks to be completed before and after tests run. Will allow folding of content in the frontend view:</p>
+
+<pre><code>before_script: command_1
+after_script: command_2
+</code></pre>
+
+<p>Or:</p>
+
+<pre><code>before_script:
+ - command_1
+ - command_2
+
+after_script:
+ - command_3
+ - command_4
+</code></pre>
+
+<h3>Set bundler args</h3>
+
+<p>Pass arguments to <code>bundle install</code> (see <a href="http://gembundler.com/man/bundle-install.1.html">http://gembundler.com/man/bundle-install.1.html</a>)</p>
+
+<pre><code>bundler_args: --binstubs
+</code></pre>
+
+<h3>Configure recipients for email notification</h3>
+
+<p>You can specify recipients that will be notified about build results.</p>
+
+<pre><code>notifications:
+ recipients:
+ - email-address-1
+ - email-address-2
+</code></pre>
+
+<p>You can also entirely turn off notifications like this:</p>
+
+<pre><code>notifications:
+ disabled: true # Disable email notifications
+</code></pre>
+
+<p>If you do not configure this then Travis CI will notify:</p>
+
+<ul>
+ <li>the commit author and the repository owner (for repositories owned by users)</li>
+ <li>the commit author and all organization members (for repositories owned by organizations)</li>
+</ul>
+
+<h3>Specify branches to build</h3>
+
+<p>You can either white- or blacklist branches that you want to be build by using <code>only</code> or <code>except</code> keys. If you specify both, except will be ignored:</p>
+
+<pre><code>branches:
+ only:
+ - master
+ except:
+ - legacy
+</code></pre>
+
+ </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">Mailinglist</a></li>
+ </ul>
+ <h2>Documentation</h2>
+ <ul>
+ <li><a href="/docs/getting-started/">Getting started</a></li>
+ <li><a href="/docs/build-configuration/">Build configuration</a></li>
+ </ul>
+ <h2>Under construction</h2>
+ <ul>
+ <li><p>Our site is still under construction. You can help us in: travis#irc.freenode.net</p></li>
+ </ul>
+ </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="http://github.com/travis-ci/travis-ci" title="">View the Source</a></li>
+ <li><a href="http://twitter.com/travisci" title="">Travis CI on Twitter</a></li>
+ </ul>
+ </div><!-- /.box -->
+ </div><!-- /.wrapper -->
+ </div><!-- /#footer -->
+ </body>
+</html>
@@ -0,0 +1,107 @@
+<!DOCTYPE HTML>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Travis CI: About - Getting started</title>
+ <link rel="stylesheet" type="text/css" href="/style.css" media="screen">
+ </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</a></li>
+ <li><a href="/docs/">Docs</a></li>
+ <li class="right"><a href="http://travis-ci.org">go to travis-ci.org &rarr;</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div id="header">
+ <div class="wrapper">
+ <h1 class="riddle"><a href="/" title="Travis">Travis CI</a></h1>
+ <p>An open-source, distributed build system for the Ruby community.</p>
+ </div><!-- /.wrapper -->
+ </div><!-- /#header -->
+
+ <div id="content">
+ <div class="wrapper">
+ <div class="pad">
+ <div id="main">
+
+ <h2>Getting started</h2>
+
+
+ <h3>Sign in</h3>
+
+<p>To get started with Travis CI simply sign in through Github oauth (i.e. go to <a href="http://travis-ci.org">Travis CI</a> and click the link on the top right).</p>
+
+<p>Github will ask you for granting read- and write access. Travis CI needs write access for setting up service hooks for your repositories when you request it, but it won’t touch anything else.</p>
+
+<h3>Add service hooks</h3>
+
+<p>Once you’re signed in go to your <a href="http://travis-ci.org/profile">profile page</a>. You’ll see a list of your repositories. Simply click the on/off switch for each repository that you want to hook up on Travis CI.</p>
+
+<p>You can then click on the small wrench icon next to the on/off switch to get to your service hooks page.</p>
+
+<h3>Prepare your build</h3>
+
+<p>In order to build on Travis CI your repository needs to have a Gemfile (unless you do not have <em>any</em> dependencies to install) and a Rakefile with a default test task (unless you specify a different build script in your configuration, see below).</p>
+
+<p>That’s it. Travis CI will run <code>bundle install</code> (if you have a Gemfile) and then <code>rake</code> for you by default.</p>
+
+<h3>Start your build</h3>
+
+<p>To start a build you can either commit and push something to your repository. Or you can go to your service hooks page and click the “Test Hook” button.</p>
+
+<p>That should put a build job into the job queue on <a href="http://travis-ci.org">Travis CI</a> and your build will start as soon as a worker is available.</p>
+
+<h3>Tweaking your build configuration</h3>
+
+<p>You can configure your build by adding a file <code>.travis.yml</code> to your repository. See <a href="/docs/build-configuration/">Build Configuration</a> for details.</p>
+
+<h3>Need help?</h3>
+
+<p>For any kind of questions feel free to join our IRC channel <a href="irc://irc.freenode.net#travis">#travis on irc.freenode.net</a>! We’re there to help :)</p>
+
+ </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">Mailinglist</a></li>
+ </ul>
+ <h2>Documentation</h2>
+ <ul>
+ <li><a href="/docs/getting-started/">Getting started</a></li>
+ <li><a href="/docs/build-configuration/">Build configuration</a></li>
+ </ul>
+ <h2>Under construction</h2>
+ <ul>
+ <li><p>Our site is still under construction. You can help us in: travis#irc.freenode.net</p></li>
+ </ul>
+ </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="http://github.com/travis-ci/travis-ci" title="">View the Source</a></li>
+ <li><a href="http://twitter.com/travisci" title="">Travis CI on Twitter</a></li>
+ </ul>
+ </div><!-- /.box -->
+ </div><!-- /.wrapper -->
+ </div><!-- /#footer -->
+ </body>
+</html>
Oops, something went wrong.

0 comments on commit e9cfea5

Please sign in to comment.