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

33 lines
1.4 KiB
Markdown
Raw Normal View History

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>
2020-11-30 11:59:53 +00:00
# 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.
chore(docker): use NIMFLAGS instead of NIM_PARAMS (#961) NIM_PARAMS is and internal variable. NIMFLAGS should be used outside of nimbus build system. includes: * fix(docker): copy RLN parameters.key into the container * chore(makefile): NIMFLAGS in docker img rule
2022-05-17 19:11:07 +00:00
* `NIMFLAGS` - Nim compilation parameters.
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>
2020-11-30 11:59:53 +00:00
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',
```