Publishing Lucee Extensions to ForgeBox

Requirements

In order to publish you extension (or any other package for that matter) to ForgeBox you just need three things

1. A forgebox account (use forgebox register if you don’t have one)

2. A box.json with the correct metadata in your package.

3. Run the publish command from that folder.

Package Metadata

In your box.json, you’ll want to minimally have the following properties set:

• The slug property in your box.json to be the unique GUID of your extension from your manifest file. Lucee's docs state this needs to be a UUID. It needs to match what’s in your manifest or updates won’t work.

• The version needs to be the current version of your package that you want to publish. To add a new version, you’ll just update the json and re-run the publish command. One thing to watch out for is that Lucee likes to use the x.y.z.q version format which does not quite match the npm-style x.y.z-prerelease+build format of ForgeBox. I usually stick with just three digits x.y.z so it’s compatible across the board.

• You want the type property in your json to be lucee-extensions

• Set your publicly-acessable thumbnail URL in a thumbnail property in the json

• Fill out any other info like name (human readable), author, etc

Package Description

The publish command will pick up any readme.md file in your current directory where you run the publish command and will put it on ForgeBox as the description. This is very handy so make sure you have a good readme so your package home looks good. If you want to update it, simply edit the readme file and re-run the publish command at any time.

Sample box.json

{
    "name":"Ortus Couchbase Cache",
    "version":"3.0.0",
    "author":"Brad Wood",
    "location":"https://s3.amazonaws.com/downloads.ortussolutions.com/ortussolutions/couchbase-extension/couchbase-cache-3.0.0.lex",
    "slug":"14B0C2A7-5CFC-4606-9167C93959A8B82C",
    "description":"A Lucee caching extension allow you to connect to a Couchbase Cluster for caching, session, and client storage",
    "type":"lucee-extensions",
    "thumbnail":"https://s3.amazonaws.com/downloads.ortussolutions.com/ortussolutions/couchbase-extension/couchbase-cache-logo.png"
}

Advanced properties

• lucee-extension-category

• lucee-extension-releasetype

• lucee-extension-minloaderversion

• lucee-extension-mincoreversion

• lucee-extension-price

• lucee-extension-currency

• lucee-extension-disablefull

• lucee-extension-trial

• lucee-extension-promotionlevel

• lucee-extension-promotiontext