-
Notifications
You must be signed in to change notification settings - Fork 25.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved documentation for the ciabot scripts.
Signed-off-by: Eric S. Raymond <esr@thyrsus.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
- Loading branch information
1 parent
c142616
commit 6484070
Showing
2 changed files
with
50 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
= Installation instructions = | ||
|
||
Two scripts are included. The Python one (ciabot.py) is faster and | ||
more capable; the shell one (ciabot.sh) is a fallback in case Python | ||
gives your git hosting site indigestion. (I know of no such sites.) | ||
|
||
It is no longer necessary to modify the script in order to put it | ||
in place; in fact, this is now discouraged. It is entirely | ||
configurable with the following git config variables: | ||
|
||
ciabot.project = name of the project (required) | ||
ciabot.repo = name of the project repo for gitweb/cgit purposes | ||
ciabot.xmlrpc = if true (default), ship notifications via XML-RPC | ||
ciabot.revformat = format in which the revision is shown | ||
|
||
The ciabot.repo value defaults to ciabot.project lowercased. | ||
|
||
The revformat variable may have the following values | ||
raw -> full hex ID of commit | ||
short -> first 12 chars of hex ID | ||
describe -> describe relative to last tag, falling back to short | ||
The default is 'describe'. | ||
|
||
Once you've set these variables, try your script with -n to see the | ||
notification message dumped to stdout and verify that it looks sane. | ||
|
||
After verifying correct function, install one of these scripts either | ||
in a post-commit hook or in an update hook. | ||
|
||
In post-commit, run it without arguments. It will query for | ||
current HEAD and the latest commit ID to get the information it | ||
needs. | ||
|
||
In update, call it with a refname followed by a list of commits: | ||
You want to reverse the order git rev-list emits because it lists | ||
from most recent to oldest. | ||
|
||
/path/to/ciabot.py ${refname} $(git rev-list ${oldhead}..${newhead} | tac) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters