mirror of
https://github.com/waku-org/nwaku.git
synced 2025-01-19 11:22:38 +00:00
b51fb61669
* chore(docs): fix docs and mark some as deprecated * Update docs/contributors/continuous-integration.md Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com> * Update examples/v2/README.md Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com> * mark TODO with date * replace nim-waku with nwaku in docs --------- Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com>
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
# 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 four jobs:
|
|
|
|
* [manual](https://ci.infra.status.im/job/nim-waku/job/manual/) - For manually executing builds using parameters.
|
|
* [deploy-wakuv1-test](https://ci.infra.status.im/job/nim-waku/job/deploy-wakuv1-test/) - Builds every new commit in `master` and deploys to `wakuv1.test` fleet.
|
|
* [deploy-wakuv2-test](https://ci.infra.status.im/job/nim-waku/job/deploy-wakuv2-test/) - Builds every new commit in `master` and deploys to `wakuv2.test` fleet.
|
|
* [deploy-wakuv2-prod](https://ci.infra.status.im/job/nim-waku/job/deploy-wakuv2-prod/) - Currently has no automatic trigger, and deploys to `wakuv2.prod` fleet.
|
|
|
|
# Configuration
|
|
|
|
The main configuration file is [`Jenkinsfile.release`](../../ci/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](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-wakuv2-test',
|
|
```
|