This document is designed to be generic and terse. More complete documentation is available at the Opencpn Developer Manual [6].
This software uses a continous integration (CI) setup which builds and deploys artifacts which can be used by the new plugin installer. The setup is based on storing the sources on github.
In a first step, the software is built. This step uses builders from appveyor[1], circleci[2] and travis[3] to make around 10 builds for different platforms. Each build produces an xml metadata file and a tarball.
In next step the build artifacts are uploaded to a cloudsmith [4] deployment server.
All steps could be configured after cloning the oesenc_pi sources.
The appveyor builder can be activated after registering a free account
on the appveyor website. After creating the account, start following the
project. From this point a new build is initiated as soon as a commit is
pushed to github. Configuration lives in appveyor.yml.
The circleci and travis builders works the same way: register an account
and start following the project. The builds are triggered after a commit
is pushed to github. Configuration lives in .circleci/config.yml and
.travis.yml.
Circleci requires user to manually request a MacOS builder before it can be used[11]. This process has been working flawlessly.
To get the built artifacts pushed to cloudsmith after build (assuming all builders are up & running):
-
Register a free account on cloudsmith.
-
Create two open-source repositories [10] called for example opencpn-plugins-stable and opencpn-plugins-unstable
-
Set up the following environment variables in the travis[7], circleci[8] and appveyour[9] builders:
- CLOUDSMITH_API_KEY: The value of the API key for the cloudsmith account (available in the cloudsmith ui).
- CLOUDSMITH_UNSTABLE_REPO: The name of the repo for unstable (untagged) commits. My is alec-leamas/opencpn-plugins-unstable
- CLOUDSMITH_STABLE_REPO: The name of the repo for stable (tagged) commits.
After these steps, the artifacts built should start to show up in cloudsmith when built. The builder logs usually reveals possible errors.
The setup is complete when cloudsmith repos contains tarball(s) and metadata file(s). It is essential to check that the url in the metadata file matches the actual url to the tarball.
To use the generated tarballs a new ocpn-plugins.xml file needs to be generated. This is out of scope for this document, see the opencpn plugins project [5].