summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Schanzenbach <mschanzenbach@posteo.de>2021-09-03 18:21:28 +0200
committerMartin Schanzenbach <mschanzenbach@posteo.de>2021-09-03 18:21:28 +0200
commit00c03c7bb03f7ecae5b082eadf05a9bb29b0b957 (patch)
tree2ace6c5eba86831f6250b84ef760d2bfb9492e04 /doc
parent4f7ae29989473ee3089a95618f27b26c8f7bd9a8 (diff)
HANDBOOK: Add pointers to CI
Diffstat (limited to 'doc')
-rw-r--r--doc/handbook/chapters/developer.texi28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi
index 3d9493cec..cf13fd816 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/handbook/chapters/developer.texi
@@ -689,6 +689,7 @@ Here you can find some rules to help you write code for GNUnet.
@menu
* Naming conventions::
* Coding style::
+* Continuous integration::
* Commit messages and developer branches::
@end menu
@@ -1094,6 +1095,33 @@ fun (short i,
@end itemize
+@cindex Continuous integration
+@node Continuous integration
+@subsection Continuous integration
+
+The continuous integration buildbot can be found at @uref{https://buildbot.gnunet.org}.
+Repositories need to be enabled by a buildbot admin in order to participate
+in the builds.
+
+The buildbot can be configured to process scripts in your repository root under @code{.buildbot/}:
+
+The files @code{build.sh}, @code{install.sh} and @code{test.sh} are executed
+in order if present. If you want a specific worker to behave differently,
+you can provide a worker specific script, e.g. @code{myworker_build.sh}.
+In this case, the generic step will not be executed.
+
+For the @code{gnunet.git} repository, you may use "!tarball" or "!coverity" in
+your commit messages.
+"!tarball" will trigger a @code{make dist} of the gnunet source and verify that it
+can be compiled. The artifact will then be published to @uref{https://buildbot.gnunet.org/artifacts}.
+This is a good way to create a tarball for a release as it verifies the build
+on another machine.
+
+The "!coverity" trigger will trigger a coverity build and submit the results
+for analysis to coverity: @uref{https://scan.coverity.com/}.
+Only developers with accounts for the GNUnet project on coverity.com are able to
+see the analysis results.
+
@cindex Commit messages and developer branches
@node Commit messages and developer branches
@subsection Commit messages and developer branches