aboutsummaryrefslogtreecommitdiff
path: root/doc/guix.texi
diff options
context:
space:
mode:
authorMathieu Othacehe <othacehe@gnu.org>2021-01-22 09:44:45 +0100
committerMathieu Othacehe <othacehe@gnu.org>2021-02-19 20:10:09 +0100
commite9bf51108272977d61a34e1af753f5064f0d57c7 (patch)
treed7134468689b93802403b578271672db064eba2e /doc/guix.texi
parent25ad6e1d8ee268bbf57a48481467a1b13a4fbbb2 (diff)
downloadguix-e9bf51108272977d61a34e1af753f5064f0d57c7.tar
guix-e9bf51108272977d61a34e1af753f5064f0d57c7.tar.gz
services: cuirass: Add "simple-cuirass-services".
* gnu/services/cuirass.scm (<build-manifest>, <simple-cuirass-configuration>): New records. (build-manifest, build-manifest?, simple-cuirass-configuration, simple-cuirass-configuration?, simple-cuirass-services): New procedures. (%default-cuirass-config): New variable. * gnu/tests/cuirass.scm (%cuirass-simple-test): New variable. * doc/guix.texi (Continuous Integration): Document it.
Diffstat (limited to 'doc/guix.texi')
-rw-r--r--doc/guix.texi102
1 files changed, 102 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 5d28fca837..30e9b052e0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -27133,6 +27133,108 @@ The Cuirass package to use.
@end table
@end deftp
+@cindex simple cuirass
+@subsubheading Simple Cuirass
+
+The Cuirass service configuration described above can be a little
+intimidating. The @code{simple-cuirass-services} procedure offers a way
+to setup a continuous integration server more readily.
+
+It takes a @code{simple-cuirass-configuration} record as its first
+argument.
+
+@deftp {Data Type} simple-cuirass-configuration
+Data type representing the configuration of a simple Cuirass instance.
+
+@table @asis
+@item @code{build} (default: @code{'all})
+The packages to be built by Cuirass. It defaults to @code{'all}, which
+means that all the discovered packages in the subsequent @code{channels}
+field are to be selected.
+
+It is also possible to set this field to a list of @code{build-manifest}
+records, so that only the packages that are part of the declared
+manifests are built. This record is described below.
+
+@deftp {Data Type} build-manifest
+@table @asis
+@item @code{channel-name}
+The name of the channel where the manifest is located.
+
+@item @code{manifest}
+The manifest path inside the channel.
+
+@end table
+@end deftp
+
+@item @code{channels} (default: @code{%default-channels})
+The channels to be fetched by Cuirass, see @pxref{Channels}.
+
+@item @code{non-package-channels} (default: @code{'()})
+List the channel names that must not be searched for packages. That is
+often the case for the channel containing the manifest.
+
+@item @code{systems} (default: @code{(list (%current-system))})
+Build every discovered package for each system in this list. By default
+only the current system is selected.
+
+@end table
+@end deftp
+
+Here is an example of how to setup a Cuirass instance that builds all
+the packages declared by Guix and a user repository. The package list
+is re-evaluated each time a commit is pushed in one of the declared
+channels.
+
+@lisp
+(simple-cuirass-services
+ (simple-cuirass-configuration
+ (build 'all)
+ (channels (cons (channel
+ (name 'my-guix)
+ (url "https://my-git-repo/guix.git"))
+ %default-channels))))
+@end lisp
+
+In the same spirit, this builds all the packages that are part of the
+@code{'guix} or @code{'my-guix} channels and declared in the manifest
+located in the @code{'conf} channel.
+
+@lisp
+(simple-cuirass-services
+ (simple-cuirass-configuration
+ (build (list
+ (build-manifest
+ (channel-name 'conf)
+ (manifest "guix/manifest.scm"))))
+ (channels (cons* (channel
+ (name 'my-guix)
+ (url "https://my-git-repo/guix.git"))
+ (channel
+ (name 'conf)
+ (url "https://my-git-repo/conf.git"))
+ %default-channels))
+ (non-package-channels '(conf))))
+@end lisp
+
+Finally, @code{simple-cuirass-services} takes as a second optional
+argument a @code{cuirass-configuration} record. It can be used to
+customize the configuration of the Cuirass instance.
+
+@lisp
+(simple-cuirass-services
+ (simple-cuirass-configuration
+ (build 'all)
+ (channels (cons (channel
+ (name 'my-guix)
+ (url "https://my-git-repo/guix.git"))
+ %default-channels))
+ (non-package-channels '(conf)))
+ (cuirass-configuration
+ (inherit %default-cuirass-config)
+ (host "0.0.0.0"))) ;listen on all interfaces.
+@end lisp
+
@node Power Management Services
@subsection Power Management Services