Lock Plugin Metadata

This repository contains metadata about the Morpheus plugin starter packages which can be used as templates for new plugin projects via Lock.

Summary

Lock is a CLI tool which will scaffold a new Morpheus plugin development project directory with skeleton code from a git repository: code which should build locally and upload to Morpheus. A good solid place to start, so that what you break next is on you ;)

Lock may also help with the developer feedback loop, building and uploading on file change, and feeding back. It is possible.

Lock is in development. It's very early stage and these are initial ideas, so the format of the metadata included here is likely to change.

How?

The basic idea is that Lock will poll this repository for data about repositories which contain morpheus plugins: templates, starters, maybe even production quality plugins (but we have share.morpheusdata.com for that).

Lock will create projects by cloning a repository and checking out a specific tag in the cloned repository - or default to head.

All the tag info will be found by cloning, but format inconsistency is likely. The metadata here is limited but aims to inform Lock how to interprete the branch/tag/release naming system used in each repository, and indeed the availability of it, when displaying repositories which can be used as starters.

Metadata is "currently" YAML syntax, and this is the "current" configuration format:

---
- plugin:
    ## category: approval, cypher, dns, tab, ipam, task, report, cloud, or backup
    category: a category
    description: description of the plugin/repo
    url: url from which the repo can be cloned
    
    ## tags are for additional metadata not tags from the repository
    tags: tag1,tag2,tag3
    
    ## these below configuration options are shown with their defaults
    ## unless a different value is specified they may be omitted
    versioning:
      semantic: false 
      semanticPrefix: v
      morpheus: false
      morpheusPrefix: morpheus
    minimumMorpheus: 6.1.0  
    disabled: false

The metadata file lock.yaml can be viewed here.

Contributions

Once the format is finalised and the Lock application is version 1, contributions will be accepted.