~didrocks/tarmac/use-pid-file

« back to all changes in this revision

Viewing changes to README

  • Committer: Paul Hummer
  • Date: 2010-10-25 18:43:25 UTC
  • mto: This revision was merged to the branch mainline in revision 379.
  • Revision ID: paul@eventuallyanyway.com-20101025184325-wmy29qkxueyq72ed
Removed icky README, directing people to the actual introduction.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Introduction
2
 
============
3
 
 
4
 
The Tarmac Launchpad Branch Lander automatically lands branches for a project
5
 
hosted on Launchpad after the merges have been properly approved.  It uses the
6
 
Launchpad REST API to find approved merge proposals against the current
7
 
development focus, and automatically merges those branches.
8
 
 
9
 
 
10
 
Installation
11
 
============
12
 
 
13
 
Download the most recent Tarmac tarball or checkout the branch with ``bzr
14
 
branch lp:tarmac``.  Within the tarmac directory, one can run ``tarmac land``
15
 
straight from there, or run ``python setup.py install`` to install it to the
16
 
system.
17
 
 
18
 
 
19
 
Authentication
20
 
==============
21
 
 
22
 
When running Tarmac for the first time, it will need to get an OAuth token from
23
 
Launchpad to allow it to act as a user.  One can do this by running the
24
 
following command:
25
 
 
26
 
  ``tarmac authenticate``
27
 
 
28
 
  ...and then follow the instructions.  The token will be placed in
29
 
``$HOME/.config/tarmac/credentials``.  Tarmac does need to write some data, so
30
 
it's required that the token have at least write access as the user.
31
 
 
32
 
 
33
 
Usage
34
 
=====
35
 
 
36
 
To land branches with Tarmac, you should run ``tarmac land lp:<branch>``.  For
37
 
instance, if I wanted to land all approved merge proposals for lp:tarmac, I'd
38
 
run ``tarmac land lp:tarmac``.
39
 
 
40
 
Tarmac recognizes branches to land when the merge proposal's status (not the
41
 
votes) is "Approved" and a valid commit message has been set for the branch.
42
 
If a branch isn't being picked up by Tarmac to land, then one of these issues
43
 
is probably the culprit.
 
1
Tarmac is a script for merging bzr branches from launchpad.  It has many
 
2
features.  To get started, please see docs/introduction.txt