Releasing your ZenPack

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

So, you've written a cool new ZenPack and you want to share it with the world. Cool! Here are the steps to follow to make your ZenPack ready for release.

Pre-Release Checklist

Now, let's cover some important steps that are required prior to preparing your ZenPack for release.

Copyright and License

Before you release your ZenPack, ensure that it contains proper copyright and license information. A copyright statement indicates that you (or your organization) are the author of the work, while the license defines the terms by which others can use your work. ZenPacks are typically released under the GNU General Public License version 2, with a clause specifying that any later version of the GNU General Public License can also be used.

For new ZenPacks, we recommend placing a file called COPYRIGHT.txt in the root of your source tree. Typically, it looks like this:

# Copyright 2012 <YOUR NAME OR ORGANIZATION HERE>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 or (at your
# option) any later version as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
# USA.
#

It is also recommended that you create a file called LICENSE.txt that contains the full license text (GNU General Public License version 2 text here.)

Since you are releasing your ZenPack publicly, it's very important that you add proper copyright and license information to your source code. This identifies you as the author of the work, and gives others the right to distribute it, use it, and improve it.

We also suggest that you release your source code under an OSI-approved free software license, and the standard license of the Zenoss community is the GNU General Public License version 2 (or later.) We also strongly recommend that you carefully read the license you choose so that you understand the terms under which you are distributing your ZenPack to the world.

Picking a Version

You'll also need to choose a version number for your ZenPack. We recommend using a format x.y.z, typically starting at 1.0.0 (though you can start at 0.x.y if you want.) The first digit is the major version, the second is the minor version, and the third is the revision. This is a convention used by the Zenoss community, so we recommend that you stick with it :)

Adding to the ZenPack Catalog

Zenoss encourages contributions of new ZenPacks from the Zenoss user community. You can use this form to request a ZenPack be added to the ZenPack Catalog.