After accomplishing the Plugin Documentation and describing the plugin on the Plugin Manifest, the plugin is now ready to be submitted for approval. This article aims to inform plugin developers of the tools provided by Reekoh and the process for submitting plugins for QA Review and Approval.
Reekoh CLI Installation and Setup
The Reekoh CLI is a command line driven tool that Reekoh provides for working and managing plugins and plugin releases. Together with the Plugin Manifest, it packages the plugin/release files and uploads it to the Reekoh. To install the CLI, go to your terminal and execute the following command:
npm install rkh-cli -g
To verify if the CLI has been installed correctly, execute the following command in the terminal:
Once the CLI has been installed, one can login to an account using the command below:
rkh login -u email@example.com
You will be asked to enter your Reekoh password afterwards and then select the account for which you want to log into if you have access to multiple Reekoh accounts/tenants.
If you'd like to switch to another account or role, execute the command below:
When you need to logout, just execute:
Publishing a Plugin using the CLI
Once the CLI tool has been installed and setup properly, it is ready to be able to submit a plugin for approval. Execute the following commands to publish a plugin:
cd /path/to/your/project-root rkh publish
Once the process has completed, the plugin has been submitted. The plugin will be put on the queue of plugins to be reviewed by our QA team.
To update or publish a new release on an existing plugin, you must ensure that you have not changed the plugin name in the Plugin manifest and execute the following commands:
cd /path/to/your/project-root rkh update
Plugin Approval Process
Once the plugin or release has been submitted for approval, our QA Team will inspect the code of the plugin, the unit tests submitted together with it, and its documentation. We will look for the following characteristics:
- Secure Code and Package
- Working unit tests
- Working code as per expected design/specifications
- Working code on actual pipeline deployments
Once it passes all those criteria, it will be approved and exposed automatically to our production environment. Kindly allow us some time to make the necessary tests to test the plugin. Turnaround times may vary according to volume.