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

ci: add MAKE_TARGET parameter, remove default from IMAGE_TAG 

Adjustments to Jenkinsfile to allow building of different targets and
pushing images with different tags depending on job parameters.

If we specify a `string` parameter in `parameters` they will be
overwritten in job definition after very job build.

I created four jobs at: https://ci.status.im/job/nim-waku/

* [manual](https://ci.status.im/job/nim-waku/job/manual/) - For building by hand
* [deploy-v1-test](https://ci.status.im/job/nim-waku/job/deploy-v1-test/) - Auto build from `master`
* [deploy-v2-test](https://ci.status.im/job/nim-waku/job/deploy-v2-test/) - Auto build from `master`
* [deploy-v2-prod](https://ci.status.im/job/nim-waku/job/deploy-v2-prod/) - Triggered manually

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2020-11-30 12:59:53 +01:00 committed by Jakub
parent e7d031fadd
commit 086cb81a81
2 changed files with 59 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
Jenkinsfile vendored
View File

@ -1,29 +1,6 @@
pipeline {
agent { label 'linux' }
parameters {
string(
name: 'BRANCH',
defaultValue: 'master',
description: 'Name of branch to build.'
)
string(
name: 'IMAGE_TAG',
defaultValue: 'wakunode2',
description: 'Name of Docker tag to push.'
)
string(
name: 'IMAGE_NAME',
defaultValue: 'statusteam/nim-waku',
description: 'Name of Docker image to push.'
)
string(
name: 'NIM_PARAMS',
defaultValue: '-d:disableMarchNative -d:chronicles_colors:none -d:insecure',
description: 'Flags for Nim compilation.'
)
}
options {
timestamps()
/* manage how many builds we keep */
@ -33,12 +10,37 @@ pipeline {
))
}
/* WARNING: Two more parameters can be defined.
* See 'environment' section. */
parameters {
string(
name: 'MAKE_TARGET',
description: 'Makefile target to build. Optional Parameter.',
defaultValue: params.MAKE_TARGET ?: 'wakunode2',
)
string(
name: 'IMAGE_TAG',
description: 'Name of Docker tag to push. Optional Parameter.',
defaultValue: params.IMAGE_TAG ?: 'deploy-v2-test',
)
string(
name: 'IMAGE_NAME',
description: 'Name of Docker image to push.',
defaultValue: params.IMAGE_NAME ?: 'statusteam/nim-waku',
)
string(
name: 'NIM_PARAMS',
description: 'Flags for Nim compilation.',
defaultValue: params.NIM_PARAMS ?: '-d:disableMarchNative -d:chronicles_colors:none -d:insecure',
)
}
stages {
stage('Build') {
steps { script {
image = docker.build(
"${params.IMAGE_NAME}:${env.GIT_COMMIT.take(6)}",
"--build-arg=MAKE_TARGET='${params.IMAGE_TAG}' " +
"--build-arg=MAKE_TARGET='${params.MAKE_TARGET}' " +
"--build-arg=NIM_PARAMS='${params.NIM_PARAMS}' ."
)
} }
@ -48,9 +50,7 @@ pipeline {
steps { script {
withDockerRegistry([credentialsId: "dockerhub-statusteam-auto", url: ""]) {
image.push()
}
withDockerRegistry([credentialsId: "dockerhub-statusteam-auto", url: ""]) {
image.push(params.IMAGE_TAG)
image.push(env.IMAGE_TAG)
}
} }
}

32
docs/contributors/continuous-integration.md Normal file
View File

@ -0,0 +1,32 @@
# Description
This document describes the continuous integration setup for `nim-waku`.
# Details
The CI setup exists on the Status.im Jenkins instance:
https://ci.status.im/job/nim-waku/
It currently consists four jobs:
* [manual](https://ci.status.im/job/nim-waku/job/manual/) - For manually executing builds using parameters.
* [deploy-v1-test](https://ci.status.im/job/nim-waku/job/deploy-v1-test/) - Builds every new commit in `master` and deploys to `wakuv1.test` fleet.
* [deploy-v2-test](https://ci.status.im/job/nim-waku/job/deploy-v2-test/) - Builds every new commit in `master` and deploys to `wakuv2.test` fleet.
* [deploy-v2-prod](https://ci.status.im/job/nim-waku/job/deploy-v2-prod/) - Currently has no automatic trigger, and deploys to `wakuv2.prod` fleet.
# Configuration
The main configuration file is [`Jenkinsfile`](../../Jenkinsfile) at the root of this repo.
Key part is the definition of four `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.
* `NIM_PARAMS` - Nim compilation parameters.
The use of `?:` [Elvis operator](http://groovy-lang.org/operators.html#_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.
```groovy
defaultValue: params.IMAGE_TAG ?: 'deploy-v2-test',
```