Buildserver

This repo contains a bashscript building our pdf documents and a little python "client" for querying the buildstatus. And there are also some svg batches for the buildstatus.

Usage Server

1. Copy the config.cfg.example to config.example.

2. "Register" the directory name of each repo to be build in the $repo variable in config.cfg.

3. Run build_cron.sh check in a cronjob as often as you like - it will return if the last build is still running

4. from time to time, run build_cron.sh clean to trigger a cleanup and complete rebuild. build_cron.sh force does the same without cleanup.

5. setup a pull webhook to trigger_build.php

# Usage:
# build all specified repos
./build.sh
# build only the 6th and later repos
./build.sh 6

Repository setup

Create your repositories this way:

• Makefile in the top directory
• all dependent repos are git submodules. If you want to point to a branch instead of a specific commit, use a tracking-branch (git submodule add ... -b master)
• The Makefile copies all public output to the output/ subdirectory

Add the repository to the configuration. The output can then be found under http://my-buildserver/repository/

examples:

• https://github.com/fau-fablab/document-dummy is a working repository
• https://github.com/fau-fablab/fablab-document/blob/master/README_deployment.md explains setting up the FAU FabLab LaTeX template

Usage Client:

1. Copy the config.cfg.example to config.example.

2. Adapt the buildserver url in config.cfg

3. Add the repo direcotry to you $PATH For example symlink the script (and the config) into $HOME/bin and add this to your .bashrc:

if [ -d $HOME/bin ] ; then
    export PATH="${PATH}:$HOME/bin"
fi

4. Now you can cd inside a repository wich is registered to the buildserver and run

$> buildstatus

to see information about the buildstatus in your terminal.

5. Add option -c to run checks for the current repo.

Tip:

• Use clustergit for batch processing. If you moved everything concerning the 'Einweisungen' into a folder, you can run:

$> clustergit --exec "buildstatus -c" -e "(.*)(buildserver|fablab-document)"

• You can also use the ssh-agent for keeping you ssh key unlocked for $time. Run:

$> ssh-add -t 600s

To keep your ssh key unlocked for 600s. To temporary lock and unlock the ssh-agent run:

# lock:
$> ssh-add -x
Enter lock password:
Again:
Agent locked.
# unlock:
$> ssh-add -X
Enter lock password:
Agent unlocked.

License

Unilicense