Watchman Monitoring understands that some subscribers would prefer not to have their code out in the public domain. Watchman Monitoring can collaborate on Custom Plugin development using GitHub's Private Repository option available for both free and paid GitHub accounts. The following documentation will walk you through creating a private repo and adding the Watchman Plugin Team as a collaborator.
The following assumes you have a GitHub account, if not, it takes a minute to join GitHub for free.
A paid GitHub account is not required.
GitHub Repository
A repository is the project's folder. A repository contains all of the project files and documentation. The repository stores each file's revision history. Repositories can have multiple collaborators and can be either public or private.
To begin, log into your GitHub account.
Create a New Repository
We will start by creating a new repository. You can add a repository by clicking the + (plus sign) > New repository in the upper right-hand corner, clicking the New button, or navigating to https://github.com/new
If you already have a Repository you would like to add Watchman Monitoring as a collaborator, jump to adding a collaborator.
Give your Repository a name.
We suggest the format of wm_[your_subdomain]_[plugins] for your Repository name.
Provide an optional Description.
Choose the visibility of your repo.
You can optionally initialize your repo with a read me file. This is where you would add documentation about your plugin.
If everything looks good, and the repo name is available, click Create repository.
Congratulations! You have created your repository.
Add a Collaborator
Adding the Watchman Plugin Team as a collaborator allows Watchman Monitoring to work with you in the development of your plugin(s) and integrate the plugin(s) into your Monitoring Client build.
You can add up to three (3) collaborators to a private GitHub repository.
In the repository you have created, click the Settings tab.
From the menu on the left, select Collaborators.
In the search field, enter watchmanpluginteam.
Selecting the Watchman Plugin Team from the list below will fill in the username.
Click the Add collaborator button.
Next, click the Copy invite link button
Then click the copy to clipboard symbol.
Share this link in your existing support ticket, or create a new support ticket.
Add to Your Repo
From here, you can upload existing plugins you have created, or download our custom plugin template to get started.
How can this article be improved?
Please sign in to leave a comment.