Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 4.64 KB

plugin-store.md

File metadata and controls

66 lines (39 loc) · 4.64 KB

Publishing to the Plugin Store

If you want to make your plugin available in the in-app Plugin Store, and on plugins.craftcms.com, follow this guide.

Choose a License

All plugins in the Plugin Store must have one of two licenses:

  • MIT – Use this if you aren’t planning on ever charging for your plugin, and you’re OK with other people pretty much doing whatever they want with your code, as long as they give credit back to you. (Example)
  • Craft – Use this if you are planning on charging for your plugin, and want to prevent people from using your code without paying up. (Example)

Create a LICENSE.md file at the root of your plugin’s repository, and paste in the license text, beginning with a copyright notice.

Copyright © <YOUR_NAME>

Registering your Plugin

To register your plugin, first make sure it’s published to a public GitHub repository. Then create a Craft ID account at id.craftcms.com, and connect it to your GitHub account.

{note} If your plugins are published to a GitHub organization account, make sure that the organization is checked when authenticating your GitHub account.

From your Craft ID account, go to Plugins → “Add a plugin”, and click the “Select” button next to your plugin’s repository. You will then be able to edit its description, screenshots, and other details.

Choose a Price

If you wish to sell your plugin, choose a price point that makes sense. Here are some suggested price ranges to consider:

Price Range Example Use Cases
$10-$29 Lightweight “plug and play” utilities and integrations
$49-$99 Complex field types and integrations
$149-$249 Plugins that add significant new system functionality
$499-$999 Major or highly niche applications

You will also be required to pick a Renewal Price, which is the annual fee the Plugin Store will charge customers who wish to continue installing new updates, after the first year. Pick a Renewal Price that is around 20-50% of the initial Price. For example, if you are charging $99 for your plugin, your Renewal Price should be between $19-$49.

{note} If you initially submit your plugin as free, you will not be able to change it to a commercial plugin later; you will need to submit the commercial version as a completely separate plugin. Eventually the Plugin Store will support plugin Editions, which will provide a path for free plugins to offer commercial upgrades.

Submit for Approval

Once you’re ready to submit the plugin, click the “Submit for approval” button. Once your plugin is approved, it will become visible on plugins.craftcms.com. It won’t necessarily be available in the in-app Plugin Store yet, though, unless your plugin already has at least one release.

{tip} You might want to register your plugin with Packagist in addition to the Plugin Store, so that people can install and update your plugin from the command line. But Packagist isn’t a requirement for the Plugin Store.

Plugin Releases

To release a new version of your plugin, first decide on the version number. The Plugin Store follows the same Semantic Versioning conventions supported by Composer:

  • Versions should have 3 or 4 segments (e.g. 1.2.3 or 1.2.3.4).
  • Pre-release versions should end with a release identifier (-alpha.X, -beta.X, or -RCX).

Once you’ve decided on a version, follow these steps:

  1. If your plugin has a changelog, make sure the new version has a correctly-formatted heading, including the release date.

    ## 3.0.0 - 2018-03-31

  2. If your plugin’s composer.json file includes a version property, make sure that it is set to the new version number.

  3. Once everything is good to go and committed to Git, create a tag named after the version number, optionally beginning with v (e.g. v3.0.0 or v3.0.0-beta.1). Prefixing the tag name with release- is also allowed (e.g. release-3.0.0 or release-v3.0.0).

  4. Push your latest commits and your new version tag to GitHub. At this point the Plugin Store should automatically get notified about the release, and will start recording it. If all goes well, it will show up in the Plugin Store within a minute or two.