Committing Plugins
From Sit
 |
SiT! Manual | Developers Guide → Committing Plugins | Chapter 6 |
Contents |
Adding a new plugin
After having created your plugin see creating plugins you should add the plugin to the plugins directory listing.
Plugin: short name of the plugin, with link to it's page here in the wiki Description : a short desciption of what the plugin does. Plugin Version : Version of the plugin Min SIT Version : Minimum version of SiT that the plugin can be used for, if you are in doubt, add the current released version that you are developing on. Max SIT Version : This version is the max sub-version the plugin can run, i.e. if the released version is 3.60, max version should be 3.69 Author : Your realname and eventually link to your userpage in the wiki.
You should also add a wiki page that describes in better detail (as opposed to the very short desciption made above) what the plugin does, and how to configure it if necessary. Take a look on some of the other plugin pages to get some inspiration on how/what to write.
The page should have in the top
{{Plugin|<pluginname>}}
{{Plugin Info
|name = <plugin name>
|maintainer = [[user:<your wiki username>|<your realname>]]
|image = <image name that was uploaded to the wiki>
|version = <version number of the plugin i.e. v1.23>
|status = <stable|unstable|beta|experimental>
|download = http://sourceforge.net/projects/sit-plugins/files/<your plugin>
}}
For more help, here's a link to the Plugin Info page.
Committing a plugin to the repo
First you'll need to have proper access to be able to release through the repo, you can talk to ericthefish about this.
If you are not a regular committer, you can either create a bug report with the plugin attached, it's required to follow the steps shown in Preparation of the package as shown later on this page. The plugin will need to undergo testings from a trusted source i.e. a committer or a developer etc.
NOTE: All steps are required
Though in the beginning this might take you 5-10 min, but once you get the hang of it it can take you around 1-2 minutes
Preparation of the package
You'll need to have exported the plugin and packed it into a zip file
to export the plugin (which also removes the .svn folders)
svn export https://sitracker.svn.sourceforge.net/svnroot/sitracker/branches/plugins/my_plygin
If the "my_plugin" folder already exists you can either remove the folder, or use the --force parameter in the end to overwrite.
Make sure there is a README and LICENSE file in the plugins folder. The LICENSE file containing which license the plugin is released as. and the README containing, but not limited to, a description of what the plugin does.
Before packing you'll need to have the structure in order, files are for reference only.
my_plugin\my_plugin.php
my_plugin\LICENSE
my_plugin\README
my_plugin\my_plugin\my_plugin_menu.php
my_plugin\my_plugin\i18n\en-GB.inc.php
Now you can pack the plugin, make sure you name it to fit the version of the plugin.
- The package file is required to be a zip file
zip -r my_plugin_v1.0.zip my_plugin
Uploading the plugin
Now go to the Plugin repository and log in. Create a new folder (no spaces) with the name of the plugin as referenced in the wiki plugins directory if the plugin isn't there already. Otherwise click on the foldername of the plugin, and add the file.
When upload is complete, click on the i icon, view details, and check all the OS'es that the plugin can run under, and click the save button.
Write news for the RSS
Go to Project Admin --> Project News --> Submit (make sure you are logged on to SF, else the link might not work)
If you add a new plugin, write in the subject New Plugin: <pluginname> <version> like this
New Plugin: My Plugin v1.0
If you add an update plugin, write in the subject Updated Plugin: <pluginname> <version> like this
Updated Plugin: My Plugin v1.0
In the details form, write a short description i.e.
Menu Extend has been updated to version 1.20, read more here http://sitracker.org/wiki/Menu_extend
