Dev:Addon life-cycle

From Habari Project

Jump to: navigation, search

If you start developing addons for Habari, you might wonder how you should do it so history and versions are created in a useful way. This flowchart should help you. It is not meant as a full explanation of whatever could happen to an addon, just a quick overview for newbies. It is also helpful if you are already developing but now want to use the official Addon catalog.

For simplicity, we will assume you host your addon on GitHub. See Sharing Your Work for more information on hosting.

Please note that it doesn't matter at which point you create the repository on GitHub as long as you do it before you create your first tag.


Create repo on GitHub

See Dev:Sharing Your Work.

Add your repo to the catalog

See Addon catalog.

Start developing your addon

See Dev:Creating A Plugin or Dev:Creating A Theme for details. We recommend starting with the XML file so you don't forget it later (pushing an addon that is linked to the catalog causes errors if the XML is missing or invalid).

Determine a version number

Choose the version number for your next or first release. If you want to release stable, but unmaintained versions, use version numbers below 1. Most addons start with 0.1 as their first version number. Save that version number in the XML using an own commit. If the version is a follow-up, make sure you commit the version number change in the XML right after you pushed the tag of the previous version.

Commit changes

Just develop as you usually would. :) You can use branches of course, just remember: Branches other than master are ignored by the official catalog, so make sure you merge and checkout master before you tag.

Test your addon

As you can of course commit untested changes, we recommend not pushing them before testing. If you want to do public testing you can of course push untested changes, too.

Push changes

Push changes to the hoster of your choice. To avoid errors, make sure you pushed all the code changes before you push the tag in the next step.

Create a tag when you want to release / push the tag

If your addon is stable with a certain version of Habari and has experienced some changes since the last release (or if it is the first time it's useful), you should release it. That's done by tagging it and pushing that tag. See Addon catalog for more information on that process.

Personal tools