waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nwaku/docs/contributors/continuous-integration.md

1.4 KiB
Raw Blame History

Description

This document describes the continuous integration setup for nim-waku.

Details

The CI setup exists on the Status.im Jenkins instance:

https://ci.infra.status.im/job/nim-waku/

It currently consists of four jobs:

  • manual - For manually executing builds using parameters.
  • deploy-waku-test - Builds every new commit in master and deploys to waku.test fleet.
  • deploy-waku-sandbox - Currently has no automatic trigger, and deploys to waku.sandbox fleet.

Configuration

The main configuration file is Jenkinsfile.release in the ci folder.

Key part is the definition of five parameters:

  • MAKE_TARGET - Which Makefile target is built.
  • IMAGE_TAG - Tag of the Docker image to push.
  • IMAGE_NAME - Name of the Docker image to push.
  • NIMFLAGS - Nim compilation parameters.
  • GIT_REF - Git reference to build from (branch, tag, commit...)

The use of ?: Elvis operator plays a key role in allowing parameters to be changed for each defined job in Jenkins without it being overridden by the Jenkinsfile defaults after every job run.

defaultValue: params.IMAGE_TAG ?: 'deploy-waku-test',