HowTo setup automatic refresh of repositories in Redmine on commit » History » Version 13
C. X., 2011-05-23 16:53
1 | 1 | Etienne Massip | h1. HowTo setup automatic refresh of repositories in Redmine on commit |
---|---|---|---|
2 | 4 | Mischa The Evil | |
3 | {{>toc}} |
||
4 | 1 | Etienne Massip | |
5 | 3 | Etienne Massip | Since of version 0.9.0, you can use an HTTP submission, either GET or POST, to automatically refresh Redmine after you committed your modification in your repository. |
6 | 1 | Etienne Massip | |
7 | 10 | Maxim Strukov | Examples: |
8 | 1 | Etienne Massip | |
9 | * _/sys/fetch_changesets?key=<your service key>_ fetches changesets for all active projects |
||
10 | 7 | Felix Schäfer | * _/sys/fetch_changesets?id=<project identifier>&key=<your service key>_ fetches changesets from the repository of a specific project |
11 | 1 | Etienne Massip | |
12 | 13 | C. X. | *Notice:* Instead of calling an url, you can use @ruby /path_to_redmine/redmine/script/runner "Repository.fetch_changesets" -e production > /dev/null 2>&1 &@. |
13 | |||
14 | 1 | Etienne Massip | See #2925 for original feature request. |
15 | |||
16 | h2. Step 1 : configure Redmine to accept the request |
||
17 | |||
18 | Web service for repositories must by activated in the Administration menu and the generated key will have to be used by the caller in Step 2. |
||
19 | |||
20 | h2. Step 2 : setup a post-commit script on the SCM server |
||
21 | |||
22 | You have to setup a post-commit script which will call the previous URL. |
||
23 | |||
24 | h3. Subversion |
||
25 | |||
26 | 8 | Etienne Massip | Simply add a @post-commit@ (or @post-commit.cmd@ on a Windows system) script file in the hooks sub-directory which contains the HTTP request call : |
27 | <pre><code class="sh"> |
||
28 | 1 | Etienne Massip | #!/bin/sh |
29 | |||
30 | 6 | Jürgen Hörmann | curl "http://<redmine url>/sys/fetch_changesets?key=<your service key>" |
31 | 8 | Etienne Massip | </code></pre> |
32 | 12 | razumuhin map | or if you want to use wget |
33 | <pre><code class="sh"> |
||
34 | wget "http://your/redmine/path/sys/fetch_changesets?key=<API KEY>" |
||
35 | </code></pre> |
||
36 | Note: Don`t forget wget in your computer path. |
||
37 | 11 | razumuhin map | |
38 | 1 | Etienne Massip | Or, on a Windows system (2 files) : |
39 | |||
40 | 8 | Etienne Massip | * @post-commit.cmd@ : |
41 | <pre><code class="cmd"> |
||
42 | 2 | Etienne Massip | cscript "%~dp0refresh_redmine.vbs" //Nologo >> "%~dp0refresh_redmine.log" 2>&1 |
43 | 8 | Etienne Massip | </code></pre> |
44 | 1 | Etienne Massip | |
45 | 8 | Etienne Massip | * @refresh_redmine.vbs@ : |
46 | <pre><code class="vbs"> |
||
47 | 1 | Etienne Massip | private const REDMINE_SERVICE_KEY = "<your service key>" |
48 | |||
49 | Call HTTPPost("http://<redmine url>/sys/fetch_changesets", "key=" & REDMINE_SERVICE_KEY) |
||
50 | |||
51 | Private Function HTTPPost(sUrl, sRequest) |
||
52 | set oHTTP = CreateObject("Microsoft.XMLHTTP") |
||
53 | oHTTP.open "POST", sUrl,false |
||
54 | oHTTP.setRequestHeader "Content-Type", "application/x-www-form-urlencoded" |
||
55 | oHTTP.setRequestHeader "Content-Length", Len(sRequest) |
||
56 | oHTTP.send sRequest |
||
57 | HTTPPost = oHTTP.responseText |
||
58 | End Function |
||
59 | 8 | Etienne Massip | </code></pre> |
60 | 9 | András Veres-Szentkirályi | |
61 | h3. Git |
||
62 | |||
63 | Simply add a @post-receive@ (even on a Windows system, no extension is required) script file in the hooks sub-directory which contains the HTTP request call: |
||
64 | |||
65 | <pre><code class="sh"> |
||
66 | #!/bin/sh |
||
67 | |||
68 | curl "http://<redmine url>/sys/fetch_changesets?key=<your service key>" |
||
69 | </code></pre> |
||
70 | |||
71 | This setup works in the "usual" case, where Redmine's repository is set to a bare Git repository, so no commits can happen directly in there. If you have a rare setup with a non-bare repository linked to Redmine, you need to add the script as a @post-commit@ hook as well. |
||
72 | |||
73 | Don't forget to make the file(s) executable on UNIXish systems, more information about Git hooks can be found in the "githooks":http://www.kernel.org/pub/software/scm/git/docs/githooks.html man page. |