Addon catalog

From Habari Project

Revision as of 18:06, 24 July 2013 by Konzertheld (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The addons catalog is a browsable and searchable catalog of plugins, themes and locales, where you can find and download addons.


Publishing an addon

It is no longer needed to host addons in habari-extras. You can even fork addons from habari-extras (or any other place, of course), modify them as you like and then add them to the catalog. If you forked from habari-extras, your name will show up on the catalog together with the addon's name so it is clear this is your fork.

Link your addon to the catalog

To publish your addon to the catalog, set up a post-receive hook on your GitHub hosted plugin. See GitHub's instructions and add the hook.

Provide metadata

Additionally, you need a GUID in your addon's xml file. If you are in the #habari IRC channel, you can obtain one by using ,guid. The version number in the XML must be the version number your addon will get with the next release. So if you start working on a new release, the first thing you should do is to bump (or initially create) the version number, commit and push it. Read more on Semantic versioning.

Find more information on XML on the Plugin and Theme pages. You should also check your XML's syntax.

Managing versions

To appear as a released version, you need to tag your addon, with both its version and the Habari version. The git tag must match the version number in your addon's xml file.

$ git tag 0.9-1.0 -am "Tagging version 1.0 for Habari 0.9"
$ git push origin --tags

Note that while increasing the version number in the XML is the first step in developing a certain version, tagging it should be the last step and should be followed by bumping the XML version again. By doing so, the in-development version of your addon will always have the highest version number. Also, this process makes sure your addon always has max. 1 development version in the catalog.

To avoid errors, please commit and push all changes first before creating and pushing the tag.

If you work with in-development versions of Habari (master of the Habari repo), we encourage you to tag your addon for the latest stable version of Habari and have the new code in your addon's master branch. Branches other than master will not appear in the catalog.

See also

Dev:Sharing Your Work and Dev:Addon life-cycle

Personal tools