aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2022-03-21 11:37:58 +0530
committerArun Isaac2022-03-21 11:37:58 +0530
commit955cff64eef7e1278502679d9fdcb96785dc6102 (patch)
tree259a60084d6f3cbf6c2307ce8c75fa7e57c95abb
parent37adb811e9b28b06d958ea7183e85b46f384c0cd (diff)
downloadguix-forge-955cff64eef7e1278502679d9fdcb96785dc6102.tar.gz
guix-forge-955cff64eef7e1278502679d9fdcb96785dc6102.tar.lz
guix-forge-955cff64eef7e1278502679d9fdcb96785dc6102.zip
doc: Explain what a post-receive-hook is and how it is set up.
* doc/forge.skb (Tutorial): Explain what a post-receive-hook is and how it is set up.
-rw-r--r--doc/forge.skb10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index 5c388b1..37e570c 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -129,9 +129,13 @@ defined into a continuous integration job.])
hopefully self-explanatory. The ,(code [user]) field specifies the
user who will own the git repository at the path specified by ,(code
[repository]). That user will therefore be able to push into the
-repository through ssh or similar. The ,(file [post-receive-hook]) in
-the repository will be managed by guix-forge to trigger a continuous
-integration run on every commit.])
+repository through ssh or similar. git provides various ,(ref :url
+"https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks" :text
+"server-side hooks") that trigger on various events. Of these, the
+,(file [post-receive-hook]) triggers when pushed commits are
+received. guix-forge sets up a ,(file [post-receive-hook]) script in
+the repository to trigger a continuous integration run on every
+,(command [git push]).])
(p [And finally, we put everything together in an ,(code
[operating-system]) declaration. Notice the forge service configured
with ,(code [guile-json-project]) and the laminar service configured