Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: f4cd250761
Fetching contributors…

Cannot retrieve contributors at this time

120 lines (94 sloc) 5.585 kb
<html lang="en">
<meta charset="utf-8">
<title>Travis CI: About - Getting started</title>
<link rel="stylesheet" type="text/css" href="/style.css" media="screen">
<div id="navigation">
<div class="wrapper">
<a href="" id="logo">travis-ci<span>.org</span></a>
<li><a href="/">Blog</a></li>
<li><a href="/docs/">Docs</a></li>
<li class="right"><a href="">go to &rarr;</a></li>
<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>Make sure your project can build</h3>
<p>In order to build on Travis CI, your repository should have a Rakefile with the default task being a test task. That’s it. Travis CI will first run <code>bundle install</code> if you have a Gemfile, and then <code>rake</code> by default. The build success is determined by the response code of that command.</p>
<p>You can <a href="/docs/user/build-configuration/">configure</a> all aspects of this, including the <a href="/docs/user/database-setup/">database connection</a> if you need one.</p>
<h3>Sign in</h3>
<p>To get started with Travis CI, sign in through Github OAuth. Go to <a href="">Travis CI</a> and follow the sign in link.</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="">profile page</a>. You’ll see a list of your repositories. Flip the on/off switch for each repository that you want to hook up on Travis CI.</p>
<p>Then visit the GitHub service hooks page for that project and paste your GitHub username and Travis token into the settings for the Travis service.</p>
<h3>What triggers the build process?</h3>
<p>To start a build you can either commit and push something to your repository, or you can go to your GitHub service hooks page and use the “Test Hook” button for Travis.</p>
<p>That should put a build job into the job queue on <a href="">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 <code>.travis.yml</code> file to the root of your repository. See <a href="/docs/user/build-configuration/">Build Configuration</a> for details.</p>
<h3>Databases, available infrastructure and more</h3>
<p>A Travis worker comes with a good amount of services you might depend on, including MySQL, PostgreSQL, MongoDB, memcached and others.</p>
<p>See <a href="/docs/user/database-setup/">Database setup</a> to learn how to configure a database connection for your test suite.</p>
<h3>Need help?</h3>
<p>For any kind of questions feel free to join our IRC channel <a href="irc://">#travis on</a>! We’re there to help :)</p>
</div><!-- /#main -->
<div id="sidebar">
<li><a href="">Github</a></li>
<li><a href="">Twitter</a></li>
<li><a href="irc://">IRC</a></li>
<li><a href="">Mailinglist</a></li>
<h2>User Docs</h2>
<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/status-images/">Status images</a></li>
<h2>Developer Docs</h2>
<li><a href="/docs/dev/worker/">The worker</a></li>
<h2>Under construction</h2>
<li><p>Our site is still under construction. You can help us in:</p></li>
</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="">Travis CI community</a>. Feel free to <a href="">contribute</a>!</p>
<div class="box">
<p>This design was kindly provided by the talented Ben Webster of <a href="">Plus2</a>.</p>
<div class="box last">
<li><a href="" title="">View the Source</a></li>
<li><a href="" title="">Travis CI on Twitter</a></li>
</div><!-- /.box -->
</div><!-- /.wrapper -->
</div><!-- /#footer -->
Jump to Line
Something went wrong with that request. Please try again.