Process: CI Outline

[rgleason]

TestPlugin Development Manual

Plugin System Structure
Deployment Overview
Translations Internationalization (i18n) Process

Currently all processes use Github, CircleCI and Cloudsmith. Appveyor and Travis-CI are no longer used.
You should register for free opensource accounts with Github, CircleCI and Cloudsmith.

Review Prerequisite Cloud Services

Github authorizations. Set up Github Deploy Key - complete later.
See #3-8
See You will need the ssh url to your OpenCPN/plugins fork, something like git@github.com:Rasbats/plugins.git. This can be found in the Github UI
Take a note about GIT_REPO and GIT_KEY_PASSWORD, they are used in later configuration steps.
You will add to your CirclceCI project, and Environmental Variable "GIT_REPO" and use the key.
https://opencpn-manuals.github.io/main/AlternativeWorkflow/InstallConfigure/Builders/CircleCI.html

From one of your repositories such as https://github.com/[user]/AutoTrackRaymarine_pi
Under your online Github account Settings > Integrations > Applications > CircleCI Checks

• Check Read access to files located at .circleci/config.yml, Read access to metadata, Read and write access to checks

• Under Repository access select All repositories or Only select repositories.

• Then Save.

• See the status of your CircleCI workflows under the Pull Request Checks tab in the GitHub UI. With checks enabled, users will now be able to go to the Checks tab in GitHub to view the full hierarchy and status of CircleCI builds.

• Note - You cannot enable GitHub Checks for CircleCI from the GitHub UI, you must log into CircleCI and enable checks for your organization. You must have admin privileges for your organization to enable checks.

CircleCI Account

Cloudsmith Deployment Setup

Review Authorization Keys

Get your CLOUDSMITH_API_KEY and enter it into CircleCI so that deployment of files to Cloudsmith will succeed.
CLOUDSMITH_API_KEY Generation and Use

In CircleCI under your project plugin, set the Environment Variables

Go to the project settings for TideFinder
Select Environment Variables
Add the Environment Variable for Cloudsmith - this is the CLOUDSMITH_API_KEY that was saved previously

Then Use the plugins clone SSH url and the password you used for making the keys to create further Environment Variables in the CircleCI Plugin project. See https://opencpn-manuals.github.io/main/AlternativeWorkflow/InstallConfigure/Builders/CircleCI.html#_environment_variables

Cloudsmith Deployment Configuration

[rgleason]

Quinton, work in process, but should help