Publishing Plugins

So, you've created your new magic, world solving plugin, and naturally, you want to share it with the world. CFWheels uses forgebox.io as a plugins repository. This enables us to our CFWheels application's dependencies, install updates easily via Commandbox and more.
As a plugin author, it's well worth spending a little time setting yourself up to work with forgebox with the minimum amount of effort. Once done, you'll be able to either publish directly from the commandline, or upload to forgebox manually.
This tutorial makes extensive use of Commandbox, GIT and the CFWheels CLI.
Requirements
We strongly recommend always having the latest version of Commandbox.
You'll also want the CFWheels CLI. You can install that in commandbox via install cfwheels-cli. This will also update it if you've got an older version installed.
Some scripted commands also require the git CLI, although these are technically optional.
Setup a forgebox user account
If you've not got a forgebox.io account you can either register directly on forgebox or very quickly via commandbox itself
Commandbox
1
# Register for an account
2
$ forgebox register
Copied!
Once you've got your credentials, you should be good to go.
If you've already got an account, you need to login at least once, which will store an API token for future use:
Commandbox
1
# Login
2
$ forgebox login
3
​
4
# (optional) Check which account you're logged in with
5
$ forgebox whoami
Copied!
Ensure you've got a box.json in your plugin root
Forgebox uses your local box.json - you'll need one! Critical package information like the name of your plugin and the location are stored here. You can create one manually, or you can run:
Shell
1
# Create a basic box.json
2
$ init
3
​
4
# Or pass in parameters at the same time
5
$ init name="My Funky Plugin" slug=my-funky-plugin version=1.0.0 type="cfwheels-plugins"
6
​
7
# Or use the wizard
8
$ init --wizard
Copied!
Ensure you've set some critical box.json attributes
In order for other CFWheels users to quickly identify and install your plugin via the CFWheels CLI, make sure you set the following box.json attributes - whilst a standard box.json might only have name, version,author, we need a little more information. Here's a template to get you started: (replace the values in CAPS)
box.json
1
{ 
2
  // Required: 
3
 "name":"PLUGIN-NAME", 
4
 "version":"0.0.1", 
5
 "author":"YOURNAME",
6
  // Required: GitHub Repository stub
7
 "location":"GITHUBUSERNAME/GITHUB-REPONAME#v0.0.1",
8
  // Required: Should always be /plugins/
9
 "directory":"/plugins/",
10
  // Required: Should always be true
11
 "createPackageDirectory":true,
12
  // Required: Must be the name of your primary CFC File
13
 "packageDirectory":"PLUGIN-NAME",
14
  // Required: The Forgebox slug, must be unique
15
 "slug":"FORGEBOX-SLUG",
16
  // Required: Must be cfwheels-plugins
17
 "type":"cfwheels-plugins",
18
  // Required: From here is optional but recommended
19
 "homepage":"https://github.com/GITHUBUSERNAME/GITHUB-REPONAME",
20
 "shortDescription":"PLUGIN DESCRIPTION",
21
 "keywords":"KEYWORD",
22
 "private":false,
23
 "scripts":{
24
   "postVersion":"package set location='GITHUBUSERNAME/GITHUB-REPONAME#v`package version`'",
25
 "patch-release":"bump --patch",
26
 "minor-release":"bump --minor",
27
 "major-release":"bump --major",
28
 "postPublish":"!git push --follow-tags && publish"
29
  }
30
}
Copied!
Your completed box.json might look something like this:
box.json
1
{ 
2
  // Required: 
3
 "name":"Shortcodes", 
4
 "version":"0.0.4", 
5
 "author":"Tom King",
6
  // Required: GitHub Repository stub, including version hash
7
 "location":"neokoenig/cfwheels-shortcodes#v0.0.4",
8
  // Required: Should always be /plugins/
9
 "directory":"/plugins/",
10
  // Required: Should always be true
11
 "createPackageDirectory":true,
12
  // Required: Must be the name of your primary CFC File
13
 "packageDirectory":"Shortcodes",
14
  // Required: The Forgebox slug, must be unique
15
 "slug":"shortcodes",
16
  // Required: Must be cfwheels-plugins
17
 "type":"cfwheels-plugins",
18
  // Required: From here is optional but recommended
19
 "homepage":"https://github.com/neokoenig/cfwheels-shortcodes",
20
 "shortDescription":"Shortcodes Plugin for CFWheels",
21
 "keywords":"shortcodes",
22
 "private":false,
23
 "scripts":{
24
   "postVersion":"package set location='neokoenig/cfwheels-shortcodes#v`package version`'", 
25
 "patch-release":"bump --patch",
26
 "minor-release":"bump --minor",
27
 "major-release":"bump --major",
28
 "postPublish":"!git push --follow-tags && publish"
29
  }
30
}
Copied!
Using the forgebox staging server (optional)
If this is the first time you've done this, you might want to try the forgebox staging server. That way you can make sure your publishing process is spot on without having lots of unnecessary versions pushed up. You can view the staging server version at http://forgebox.stg.ortussolutions.com/​
Commandbox
1
# Add staging server configuration
2
$ config set endpoints.forgebox.APIURL=http://forgebox.stg.ortussolutions.com/api/v1
3
​
4
# Revert back to production configuration
5
$ config clear endpoints.forgebox.APIURL
Copied!
Remember this configuration will "stick", so make sure you change it back afterwards. (I find once changed, it might not kick in until you reload the commandbox shell via r).
Publishing a plugin to forgebox
Both CFWheels CLI and Forgebox are expecting a tagged release with the plugin contents (e.g. zip). So the best way to publish is to...
1.Navigate into the plugin directory
2.Ensure that directory is authorized to publish the repo (e.g. git remote -v should list your fetch/push endpoints)
Note: Git dislikes nested repos, so it's best to setup a test wheels site specifically for plugin development/deployment. Then git init within each plugin directory itself, but not at the root. (e.g. /plugins/PluginName/)
Commandbox
1
# from Commandbox prompt, within plugin directory
2
$ run-script patch-release
Copied!
ForgeBox does not store your actual package files like npm, but points to your download location. 
The following should happen (again, assuming you have git publish rights from that plugin directory)
1.Auto increment your version number within box.json
2.Push updated box.json to forgebox (with new version number + location)
3.Create a git "Tagged Release" which is basically a zip containing the source files
Once you run this command, you can run forgebox show my-package to confirm it's there. If you change the slug, a new package will be created. If you change the version, a new version will be added to the existing package.
Adding a new version via publishing scripts
By adding the following block to our box.json, we can more easily deploy new versions with a single command:
box.json
1
"scripts":{
2
   "postVersion":"package set location='GITHUBUSERNAME/GITHUB-REPONAME#v`package version`'", 
3
 "patch-release":"bump --patch",
4
 "minor-release":"bump --minor",
5
 "major-release":"bump --major",
6
 "postPublish":"!git push --follow-tags && publish"
7
  }
Copied!
Obviously, you'll need to change location='GITHUBUSERNAME/GITHUB-REPONAME#v to your repo.
With these in place, once you've committed your changes to your local repository, you can now do:
Commandbox
1
# Don't forget to commit your changes. You can access git directly from commandbox using !
2
$ !git add .
3
$ !git commit -m "my new changes"
4
​
5
# Move from 1.0.0 -> 1.0.1
6
$ run-script patch-release
7
​
8
# Move from 1.0.0 -> 1.1.0
9
$ run-script minor-release
10
​
11
# Move from 1.0.0 -> 2.0.0
12
$ run-script major-release
Copied!
This will: 
Set the package location to include the new version number
Publish to forgebox.io
Push your changes to gitHub (assuming you've set that up) 
Publish a gitHub tagged release
This saves you having to manually update the version number too!
Commandbox
1
# Example output of a patch release
2
$ run-script patch-release
3
​
4
Running package script [patch-release].
5
> bump --patch && publish
6
Set version = 0.1.7
7
​
8
Running package script [postVersion].
9
> package set location='neokoenig/cfwheels-cli#v`package version`'
10
Set location = neokoenig/cfwheels-cli#v0.1.7
11
Package is a Git repo.  Tagging...
12
Tag [v0.1.7] created.
13
Sending package information to ForgeBox, please wait...
14
Package is alive, you can visit it here: https://www.forgebox.io/view/cfwheels-cli
15
​
16
Running package script [postPublish].
17
> !git push --follow-tags
18
Counting objects: 10, done.
19
Delta compression using up to 12 threads.
20
Compressing objects: 100% (8/8), done.
21
Writing objects: 100% (10/10), 908 bytes | 0 bytes/s, done.
22
Total 10 (delta 5), reused 0 (delta 0)
23
remote: Resolving deltas: 100% (5/5), completed with 4 local objects.
24
To https://github.com/neokoenig/cfwheels-cli.git
25
   477648f..400604b  master -> master
26
 * [new tag]         v0.1.7 -> v0.1.7
27
​
28
Package published successfully in [forgebox]
Copied!
Lastly, you can double check it's made it into the plugins list via wheels plugins list
Removing a plugin from forgebox
Likewise, you can unpublish a plugin, but keep in mind people might be relying on your plugin, so don't do this lightly!
Commandbox
1
// Remove all versions of a package
2
$ unpublish
3
​
4
// Remove a specific version of a package
5
$ unpublish 1.2.3
6
​
7
// Skip the user confirmation prompt
8
$ unpublish 1.2.3 --force
Copied!

Plugins - Previous

Developing Plugins

Last modified 23d ago

Export as PDF

Copy link

Edit on GitHub

Contents

Requirements

Setup a forgebox user account

Ensure you've got a box.json in your plugin root

Ensure you've set some critical box.json attributes

Using the forgebox staging server (optional)

Publishing a plugin to forgebox

Adding a new version via publishing scripts

Removing a plugin from forgebox