Skip to content

Document how to set up a Jenkins build server #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions doc/systems/Build-Servers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Build Servers

## Prerequisites

- A useful build server will need roughly the following hardware:
* Not a virtual machine (we have used VMs in the past, but the performance penalty is quite high for a windows build server)
* 32GB or more of RAM (16GB may be possible to use, but will be substantially slower to build). Extra RAM can be acquired relatively cheaply if needed, if the machine has spare slots (check compatibility carefully)
* 1TB SSD (this capacity is needed because multiple builds' workspaces will be present at once). This does not need to be the primary OS drive - a separate drive also works and can generally be acquired relatively cheaply, if the machine has a spare M.2 or SATA port.
* A semi-modern processor. Most of our builds are _primarily_ single-threaded at present, so single-core performance is more important than multicore. This may change if we change to using `make -j <processors>` by default at some point in future.
- TODO: write something about `IT-25-27219`.

## Software to install

In order to set up a new build server, capable of running GUI, Uktena, and EPICS builds, you need to install the following software:
- Visual Studio
* C++
* ATL
* MFC
* .NET targeting pack
- Perl
- Java
- Maven
- Doxygen
- git
- TwinCAT bits
- symstore (`\\isis\inst$\Kits$\CompGroup\ICP\winsdk`)

## Connecting to Jenkins

Use the given URL _without_ the `-websocket` flag.

Set up two executors in Jenkins, one for EPICS with a single slot (suffixed with `_epics`, and with workspace `workspace_epics`), the other for gui/config checker/uktena and other builds, which can have multiple executors in the default workspace.

Add the `epics_build` label to the epics executor, and the `gui`, `genie`, `ConfigCheck` labels to the other executor.
Loading