Hosting documentation/File release management
From Bioinformatics.Org Wiki
The Bioinformatics.Org project management software includes a way to manage file releases, e.g., a new version of a software application.
Contents |
File modules
Any given project may want to release one or more file products under their project name. This will include any official released versions of their source code, in any format.
Before releasing files, you must first define a file module for your project. If your project has only one development tree, you will probably define only one module. If your project will be releasing multiple file sets, then additional modules may be defined.
A file module defines an actual software product. When other projects choose to make references to your products, for dependencies or other reasons, it is your file modules that will be referenced. For this reason, when a file module is defined, it cannot be deleted in case it is referenced specifically by other parts of the site.
IMPORTANT: File modules are always referenced through their parent project. People do not search for your modules; they search for your project. Modules will share bug tracking, task management, forums, members, Web site, and CVS repository.
For most projects, there will only be the need to define one file release module.
New modules vs. new projects
Projects share administrators and members, have one web site, and share a CVS repository. If it is conceivable that a new file module would ever spin off into its own development cycle, with a non-identical member set or requiring an independent web site, it is probably best to assign the product a new project, rather than just a module. It is OK to have the same member set on two projects, if they are releasing two different products.
Releasing a new file for a module
Uploading the file
IMPORTANT: This step must be completed before going to the upload form, since the system can only show the files present in the "incoming" directory at the time the form was loaded.
(Anonymous FTP is once again being supported for file uploads. Use the username "anonymous" along with your email address as the password.)
Project administrators can also access the "incoming" directory using SCP or SFTP. The following Unix SCP command is an example:
$ scp myrelease myusername@bioinformatics.org:/ftproot/incoming/
If you're using Windows, FileZilla offers a graphical interface.
For more information on SSH, please visit http://www.openssh.org/.
Accepted file types
Your file must be of the following recognized filetypes (identified by the file extension):
Extension ---------- .bash .bin .bz2 .deb .diff .diff.gz .exe .gz .i386.rpm .iso .jar .lsm .ova .pdf .pl .py .rpm .sig .sh .shar.gz .src.rpm .tar.bz2 .tar.gz .tgz .xls .zip
Selecting the file
Once you have uploaded the file, select your file from the pull-down menu and submit. If you do not see your file listed, then reload the form.
IMPORTANT: You may see files in the pull-down menu from other projects. Please do not add them to your own project. Also, files more than one hour old are purged from the "incoming" directory every minute.