Releasing Contribs

From SME Server
Jump to navigation Jump to search

Releasing Contribs

Writing

The Developers Manual has information required to write a contrib for SME Server

Releasing

For consistency between contribs it's suggested that you follow these guidelines

1. Announce your new rpm on the Contribs forum, make the subject similar to below [ANNOUNCE] rpm name

2. Submit a bug to the Bug Tracker, for SME Contribs, asking for a new component to be added with your rpm name. Include links to download your rpm including your src rpm. Include a short description, perhaps the description from the spec file

Your contrib should preferably be in the SME Dev repository, see below for how to obtain access.


  Note:
If your contrib is not in SME Dev or has no category in the SME Server Bugtracker please do so.


SME Extras Repositories

The SME Extras repository will contain RPMs that have been through a review process, RPMs in the SME Extras repository will be able to be installed directly from the Software Installer panel in the server-manager. Currently the SME Extras repository does not hold any contribs, but this will change in the future.


  Note:
The process for having your contrib included in SME Extras is currently being outlined and developed and therefore is far from complete.


Sumitting a contrib to the SME Server repository

To get your package in the SME Extras repository it has to go through a review process. The first steps to get your contrib in the SME Extras repository are:

1. Submit your contrib for Package Review in the SME Server Extras category of the Bugtracker. Be sure to add the following information:

  • (a link to) the SPEC file
  • (a link to) the source RPM (SRPM)

2. SME Server code is stored in the CVS on SourceForge. To be able to work on your code in the SME Server CVS repository you need an account on SourceForge. With this account the development team can give you access to the CVS repository. More information can be found here:

3. After you have created your SourceForge account you can ask the development team to give you developer access. Create a bug in the Bug Tracker as usual.

4. After the development team has added you to the list of developers you can create a SSH key which is necessary to get access to the SME Server CVS, more on this can be found here: F02: SSH Key Generation and Usage

5. After you have received developer access you will have to download and configure your CVS client to work with the SME Server CVS. More information can be found here: B01: Recommended User Software Configuration (en) . The SME Server development team has decided on using Mezzanine (see next item).

6. Install Mezzanine and read up on how to use it in the SME Server's Developers Guide - The SME Server development environment.

7. Subscribe yourself to the devinfo mailinglist. This is the place to discuss the developement of the server and contribs. If you have other questions, not regarding development please use the forums.

Having your contrib reviewed

  Incomplete:
This article or section needs to be expanded. Please help to fill the gaps or discuss the issue on the talk page


The review process has not been outlined.

Uploading contrib(s) to contribs.org

If you have created a contrib and wish to share with everyone then you can upload to your contribs.org/contribs directory. To do so you can use scp, sftp or rsync to upload to your contrib directory.

Make sure you have a working copy of your contrib directory, for example to use rsync we will grab a copy by typing...

rsync -avP username@contribs.org:~username/ /tmp/test/

Now make your /tmp/test directory looks like what you wish to see on your contribs.org directory, if you wish to remove a contrib from your directory you can do so by typing the following...

rsync -avP --delete /tmp/test/ username@contribs.org:~username/

And that's it now wait for mirrors to sync and have a beer.