blob: 63f1f2863dd493e29fc0d2a0515e8e82e5c05309 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
Kipper
======
A server that updates GitHub pull request commit statuses from Jenkins builds.
## Prerequisites
A Jenkins server configured with a “branches” project. This project will run a
build for all new commits pushed to a branch. The project’s name should match
the GitHub repository name appended by “-branches”. For example:
kipper-branches
Each build name will have the following format:
branch-name-5ac92
The branch name, followed by a hyphen “-”, followed by the first five characters
of the commit SHA.
## Setup
Kipper runs a web server that listens for a GitHub webhook. Configure your
GitHub project with the following webhook settings:
Payload URL: http://example.com/github/pull_request_event
Content type: application/json
Events: Pull request
Active: true
Since GitHub will be sending webhook requests to Kipper, it must be publicly
accessible.
To run Kipper, several configuration parameters must be passed in via command
line arguments in order for it to communicate with Jenkins and update commit
statuses on GitHub:
./kipper \
--jenkins-url 'http://jenkins.example.com' \
--jenkins-user-id 'username' \
--jenkins-token 'jenkins-token' \
--github-token 'github-token'
By default, Kipper will run on port 8000.
## Install
A binary built for Mac OS X is available on the [releases][1] page. Download the
binary and put it in your `PATH`.
To compile from source:
$ cargo install --git https://github.com/teddywing/kipper.git --root /usr/local
## Uninstall
$ cargo uninstall --root /usr/local kipper
## License
Copyright © 2017 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).
[1]: https://github.com/teddywing/kipper/releases
|
