bzr-testrunner

Merge lp://staging/~nmb/bzr-testrunner/update-docs-for-plugin-guide into lp://staging/bzr-testrunner

  1. update-docs-for-plugin-guide
  2. Merge into trunk
Proposed by Neil Martinsen-Burrell
Status: Merged
Merged at revision: not available
Proposed branch: lp://staging/~nmb/bzr-testrunner/update-docs-for-plugin-guide
Merge into: lp://staging/bzr-testrunner
Diff against target: 93 lines (+52/-16)
2 files modified
README (+26/-15)
__init__.py (+26/-1)
To merge this branch: bzr merge lp://staging/~nmb/bzr-testrunner/update-docs-for-plugin-guide
Reviewer Review Type Date Requested Status
bzr-testrunner Developers Pending
Review via email: mp+14825@code.staging.launchpad.net
To post a comment you must log in.
Revision history for this message
Neil Martinsen-Burrell (nmb) wrote :

This improves the documentation so that it can easily be included in the Bazaar Plugins Guide.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'README'
2--- README 2009-04-22 14:31:59 +0000
3+++ README 2009-11-13 16:15:20 +0000
4@@ -1,28 +1,39 @@
5---------------------
6- bzr-testrunner
7---------------------
8-
9-This is a "Poor man's PQM" that will run a command specified branch.conf and
10-only allow new changes in the branch if the return code of that command is 0.
11-It is intended to run a testsuite and verify that it passes before allowing
12-commits and pushes, but it should have no problem running any arbitrary command.
13+==============
14+bzr-testrunner
15+==============
16+
17+This is a "Poor man's PQM" (https://launchpad.net/pqm) that will run a command
18+specified in branch.conf and only allow new changes in the branch if the return
19+code of that command is 0. It is intended to run a test suite and verify that
20+it passes before allowing commits and pushes, but it should have no problem
21+running any arbitrary command.
22+
23+Installation
24+------------
25+
26+To install the plugin, simply use Bazaar to branch this directory into your
27+Bazaar plugins directory (usually ~/.bazaar/plugins)::
28+
29+ $ cd ~/.bazaar/plugins
30+ $ bzr branch lp:bzr-testrunner testrunner
31+
32
33 Usage
34----------
35+-----
36
37-1) Install to bazaar plugins.
38-2) Set 'pre_change_branch_tip_test_command' to the command you'd like to run in branch.conf.
39-3) You're done. When a commit or push is made, the latest code will be
40- exported to a temporary directory and the test command will be run.
41+Set 'pre_change_branch_tip_test_command' to the command you'd like to run in
42+branch.conf. When you make a commit, the command specified here will be run in
43+a temporary directory with the new code. If the command does not return 0,
44+then the commit will not run.
45
46 TODO
47----------
48+----
49
50 * Parameterize messages
51 * Check across protocols... tested on local branches and bzr+ssh so far
52
53 Authors
54----------
55+-------
56
57 james_w
58 phinze
59
60=== modified file '__init__.py'
61--- __init__.py 2009-04-22 14:32:09 +0000
62+++ __init__.py 2009-11-13 16:15:20 +0000
63@@ -1,4 +1,29 @@
64-"""Run a command before allowing a commit."""
65+"""Run a command before allowing a commit.
66+
67+This is a "Poor man's PQM" (https://launchpad.net/pqm) that will run a command
68+specified in branch.conf and only allow new changes in the branch if the return
69+code of that command is 0. It is intended to run a test suite and verify that
70+it passes before allowing commits and pushes, but it should have no problem
71+running any arbitrary command.
72+
73+Installation
74+------------
75+
76+To install the plugin, simply use Bazaar to branch this directory into your
77+Bazaar plugins directory (usually ~/.bazaar/plugins)::
78+
79+ $ cd ~/.bazaar/plugins
80+ $ bzr branch lp:bzr-testrunner testrunner
81+
82+
83+Usage
84+-----
85+
86+Set 'pre_change_branch_tip_test_command' to the command you'd like to run in
87+branch.conf. When you make a commit, the command specified here will be run in
88+a temporary directory with the new code. If the command does not return 0,
89+then the commit will not run.
90+"""
91
92 import sys
93 import os

Subscribers

People subscribed via source and target branches