summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2013-12-11 10:46:28 -0800
committerJeremy Kerr <jk@ozlabs.org>2014-01-29 17:57:17 +0800
commitbbae39da3b36c86a91d709ff169c4dd8b26f9284 (patch)
tree5f65f046c689ceeb68f6043af7cbb7fcc2c7ca18 /docs
parent6dd987e40d5d76dc96ed641723c2ece3f024f85e (diff)
downloadpatchwork-bbae39da3b36c86a91d709ff169c4dd8b26f9284.tar.bz2
patchwork-bbae39da3b36c86a91d709ff169c4dd8b26f9284.tar.xz
docs: Add a pointer to the git post-receive hook
I had to stumble upon this feature before I realized it was here inside the tools directory all along. This documentation should make it easier for the next person coming along looking for a patchwork git hook. Signed-off-by: Carl Worth <cworth@cworth.org> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/INSTALL17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/INSTALL b/docs/INSTALL
index 91c6081..2c1a0a9 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -217,6 +217,23 @@ fastcgi:
sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
+7. Optional: Configure your VCS to automatically update patches
+
+ The tools directory of the patchwork distribution contains a file
+ named post-receive.hook which is an example git hook that can be
+ used to automatically update patches to the Accepted state when
+ corresponding comits are pushed via git.
+
+ To install this hook, simply copy it to the .git/hooks directory on
+ your server, name it post-receive, and make it executable.
+
+ This sample hook has support to update patches to different states
+ depending on which branch is being pushed to. See the STATE_MAP
+ setting in that file.
+
+ If you are using a system other than git, you can likely write a
+ similar hook using pwclient to update patch state. If you do write
+ one, please contribute it.
Some errors: