See an example for a Maven project:
```
version: 1
build:
bash_commands: "mvn clean test"
deploy:
bash_commands: "mvn clean deploy -DskipTests -DaltDeploymentRepository=mks-nexus::default::https://nexus.mekomsolutions.net/repository/maven-snapshots"
rebuildOnDependencyChanges: "true"
```

Show webhook URL:

```
https://:@openmrs-cd.mekomsolutions.net/generic-webhook-trigger/invoke
```

#### `maven`:

This project type will suit to most Maven projects that simply need to apply standard Maven commands:
- `mvn clean install`
- `mvn clean deploy -DaltDeploymentRepository=...`
- with some additional nuances

Show webhook URL:

```
https://:@openmrs-cd.mekomsolutions.net/generic-webhook-trigger/invoke?projectType=maven
```

#### `distribution`:

A special project type to not only build the project using standard Maven commands but also save its Maven dependencies in a way that the distribution is rebuilt anytime one of the dependency has been rebuilt.

Show webhook URL:

```
https://:@openmrs-cd.mekomsolutions.net/generic-webhook-trigger/invoke?projectType=distribution
```

#### `openmrsmodule`, `initializer`, `odooaddon`...:

There are other types available but most of them are now deprecated, being replaced by the 3 ones described above.

The full list can be found in the [src/pipeline1/impl/](node-scripts/src/pipeline1/impl) folder.

*How to deploy a server?*

**(WIP)**

#### Using secrets in the Instance Event:

To avoid entering clear text secrets in an instance event, one can configure Jenkins Credentials functionality and use the special syntax `jenkinsCredentials()` anywhere in the instance. See more on Jenkins Credentials [here](https://www.jenkins.io/doc/book/using/using-credentials/).
For example:

```
{
group: hsc
type: dev
envVars:{
"OPENMRS_USERNAME": "jenkinsCredentials(openmrs.password)",
"PROXY_PORT": "80",
...
}
}
```

This will allow to substitute the placeholder with the matching Jenkins Credentials secret value.

However, Jenkins needs to be configured in a specific way for the secrets to be picked up.

- Credentials must be of type "Secret text".
- The name of the Credentials must either be a `group` or a pair `group_type`
- The "Secret" (text) should be a JSON object.
The secret object will then be accessible in the instance event and can be navigated through using **dot notation.**
Any amount of depth is allowed.

In the example above, the secret would look like:

```
{
"openmrs": {
"password": "password123",
...
},
...
}

```

To be made available in an instance definition, the Jenkins Credential should either be named after the instance group (eg, `hsc`) or the pair group_type (eg, `hsc_dev`).
All instances matching the group or group/type pair will be able to use the secret.

If providing conflicting secret keys, a merge strategy is applied and the group/type credentials will take precedence over the group.

## Developer Guide

>OCD3 is a Dockerized Jenkins with preconfigured jobs. Those jobs run Node JS scripts or Node-generated Bash scripts.

This explains the structure and content of the root folder of the project:

```
.
├── docker
├── jenkins
└── node-scripts
```
**node-scripts** is the Node JS scripts area, **docker** holds the Dockerfile (and other resources needed to configure the container) and **jenkins** contains the parts of Jenkins home that are preconfigured, as well as the pipelines' Jenkinsfiles.

Gradle is used to run all build tasks and package all artifacts that make OCD3.

### Working out of the sources directly

When developing on the CD the best is to mount the Docker volumes right out of the sources.

**1** - Clone the openmrs-cd repository:

**Note:** _we assume that cloned repositories should go into the home `~/repos` folder. Adapt the commands below in accordance to your own local setup._
```bash
mkdir -p ~/repos && cd ~/repos && \
git clone https://github.com/mekomsolutions/openmrs-cd && cd openmrs-cd
```
**2** - Build the Node scripts:
```bash
./gradlew node-scripts:build
```

**3** - Run the `openmrscd` container:
```bash
docker-compose up
```

### The 'node-scripts' component
Developing on OCD3 means working in here most of the time.
That is because the bulk of the logic of what OCD3 does lives here. Almost all Jenkins jobs are built on the following pattern:
>Jenkins jobs run Node scripts that generate Bash scripts that in turn perform the core CD tasks.

This is how one would build the underlying Node JS scripts:
```bash
./gradlew node-scripts:build
```
And this must be done before submitting code commits.
However note that the code base is not really built into anything since the container links directly to **/node-scripts**, but this formats the code and runs the test suite.

A detailed developer guide about the Node scripts can be found [here](readme/node-scripts/README.md).

### The 'docker' component
See [here](readme/docker/README.md).

### The 'jenkins' component

OCD3 not only needs a Docker image for its binaries but also requires a 'Jenkins home' folder that provides a pre-configured Jenkins setup:

```bash
./gradlew jenkins:build
```
This will package a zip archive of the jenkins folder.

**Note:** _Developing with the jenkins component may require to use `git clean -Xdf` from time to time. Please read the [note for developpers](readme/jenkins/README.md) first._

### The parent project (root folder)

Finally it is possible to build everything at once from the root level:
```bash
./gradlew build
```
This will cascade down to all child builds and run them.

To then deploy:

```
export mksRepoUrl=...
export mksRepoUsername=...
export mksRepoPassword=...
```

```
./gradlew deploy
```

## Starting OCD3 for production

The following steps describe a way to gather OCD3 artifacts locally and run the Docker container based on them. In a Un\*x shell:

**1** - Set the target version:
```bash
export VERSION=3.0.0-SNAPSHOT
```
**2** - Copy the artifacts out of the Nexus repo into the local Maven repo:
```bash
mvn dependency:get \
-DgroupId=net.mekomsolutions \
-DartifactId=openmrs-cd \
-Dversion=$VERSION \
-Dpackaging=zip \
-DremoteRepositories=https://nexus.mekomsolutions.net/repository/maven-public
```
**3** - Unpack everything into openmrs-cd on the home folder:
```bash
mvn dependency:copy -Dartifact=net.mekomsolutions:openmrs-cd:$VERSION:zip -DoutputDirectory=/tmp/ && unzip /tmp/openmrs-cd-$VERSION.zip -d /tmp/ && rm /tmp/openmrs-cd-$VERSION.zip && rsync -av --delete /tmp/openmrs-cd-$VERSION/ ~/openmrs-cd/ && rm -r /tmp/openmrs-cd-$VERSION
```

**4** - Run the `openmrscd` container:
```bash
docker run -dti --name openmrscd -p 8080:8080 \
-v ~/openmrs-cd/node-scripts:/opt/node-scripts \
-v ~/openmrs-cd/jenkins_home:/var/jenkins_home \
-v ~/openmrs-cd/app_data:/var/lib/openmrs_cd/app_data \
mekomsolutions/openmrscd:$VERSION
```
After the container has started, the customized Jenkins instance will be accessible at [http://localhost:8080](http://localhost:8080) with the following credentials: **admin** / **password**.

Authorize 'jenkins' user to write to the app_data folder:
```bash
docker exec -it openmrscd \
bash -c "sudo chown -R jenkins:jenkins /var/lib/openmrs_cd/app_data/"
```

**Attention:** _The app data folder will contain the CD's file-based database. Make sure to keep it in a safe location._

**5** - Setup your Maven repo:
You must configure the coordinates of your Maven repo if you intend to deploy your own Maven artifacts with the CD.
Launch the **artifact_repo.js** script to configure the artifacts repository credentials and artifacts upload URLs:
```bash
docker exec -it openmrscd \
bash -c "cd /usr/share/jenkins/ && npm install && node artifact_repo.js"
```
And answer the prompted questions.