For Users

For Users

Register For A Mule User Account
Log into your Account
Propose a New Project
Own A Project

Own a Proposed Project
Co-Own An Active Project

Become a Member (Developer) of an Active Project
Withdraw Membership From A Project
Subscribe to a Project's Mailing List
Browse Source Code
Access A Project's Source Code
Coding and Testing Your Project
Build Your Project
Access A Project's JIRA System
Create A JIRA Issue
Use a Project's Forum

For Developers

Setting up your Environment
Uploading 3rd-Party Artifacts to Maven
Manage Project Releases
Perform a Release
Announce a Release

Register For A Mule User Account

You need to create an Mule User Account if you want to become a Project Developer or Project Owner (also called project despot).

To create a NEW user account:

Click the here and enter the required information.

This signup process will allow you access to multiple applications: Muleforge Admin, Confluence, JIRA, JIVE Forums, etc.; Some of which are needed for MuleForge users who plan to commit code (MuleForge Admin), write documentation (Confluence), or resolve issues (JIRA) for MuleForge projects.

Log into your Account

If you ALREADY have an account on MuleForge:

Click 'ADMIN' from the top navigation bar.
Click 'Login' at the top right hand side of the page.

Propose a New Project

If you have an idea which would be useful as a Mule extension, then fill an online form for proposing a new MuleForge project.

Click 'Contribue->Propose' from the top navigation bar.

Own A Project

Own a Proposed Project

Proposed projects refers to those projects which have been set up in MuleForge but currently have no owner.

Only registered users may become project owners. If you haven't already signed up for a MuleForge account, please do so by following the section above 'Register for a MuleForge account'.

If you would like to own a proposed project which currently has no owner,

Click 'Projects' from the top navigation bar to view the list of MuleForge projects.
Hit the 'Own me' button next to the project you would like to own.

Co-Own An Active Project

Active projects refers to projects which are already led by an owner, possibly together with a team of developers.

A MuleForge project may have more than one owner. However, this requires careful coordination between the various owners of the project.

To request co-ownership of an active project:

First you have to apply for membership within that project. (Read the section below 'Become a Member (Developer) of a Particular Project').
Send an email requesting co-ownership of a project on the dev mailing list, which has the following format: dev@<project-name>.muleforge.org.

Become a Member (Developer) of an Active Project

Being a developer requires you to have a MuleForge account. If you haven't already registered, please do so by following the section above 'Register for a MuleForge account'.

If you would like to be included as a developer of an existing project,

Go to the homepage of the project.
Click 'Project Members' from the left navigation bar, under the 'Project Resources' heading.
Click the last link 'Apply to join as a developer' from the left navigation bar, under the 'Membership' heading. The project despot will then review your request and should contact you via email.

Being a project developer allows you to commit code and documentation to the project.

Withdraw Membership From A Project

It is important to inform the rest of the project members, especially the despot, about your membership withdrawal from the project. This can be done by sending an email to the dev mailing list belonging to the project:

Go to the homepage of the project.
From the left navigation bar, click 'Mailing Lists', under the 'Resources' heading.
The mailing list has the following format: dev@<project-name>.muleforge.org

Subscribe to a Project's Mailing List

Go to the homepage of the project.
Click 'Mailing Lists' from the side navigation bar.
Click 'Subscribe' which is found underneath the mailing list you would like to subscribe to.

Browse Source Code

All users, including unregistered users, can browse the source code of any MuleForge project.

To browse through the source code of a project:

Go to the homepage of the project.
From the left navigation bar, click 'SVN Repo', under the 'Sources' heading.

Access A Project's Source Code

Source code may be checked out to the users' local repository.

Unregistered users and registered users who are not members of that particular project, are allowed non-committer access to the source code over non-SSL WebDAV.

Project members are allowed committer access to the source code over HTTPS and WebDAV.

Go to the homepage of the project.
From the left navigation bar, click 'Explained' under the 'Sources' heading.
Non-project members: Use the URL to check out the source code under the 'Anonymous Subversion over WebDAV' heading.
Project members: Use the URL under the 'Committer Access - WebDAV' heading. Once the code is checked out, any changes or new code that is added may be committed to the online source repository.

Coding and Testing Your Project

Take time to read Mule's 'Coding Conventions'. Any code committed should follow these rules.

It is also advisable to read notes about 'Testing Mule'.

Build Your Project

Maven2 (M2) is the standard build tool for MuleForge projects. Currently, version 2.0.7 is being used.

Once you download a project from the SVN repository, build your project using Maven. You may then open the project in your favourite IDE, such as Eclipse, IntelliJ Idea and so on.

There should be no 3rd party libraries checked into the project's SVN repository. Dependencies should be declared in the POMs instead.

Refer to Project Repositories for an explanation of the directory structure of a project's repository.

Access A Project's JIRA System

If you are completely new to JIRA, have a look at the Atlassian JIRA User's Guide, where JIRA concepts are explained.

Go to the project's homepage. From the left navigation bar, click the 'JIRA Tracker' under the 'Project Resources' heading.

Create A JIRA Issue

Once you have accessed a project's JIRA system, log in using the top right 'Log In' link, unless you are already logged in.

To create a new issue for the chosen project, click 'Create New Issue' from the top navigation bar.

Use a Project's Forum

When a MuleForge project is created, a Jive forum is set up for the project. This can be accessed from by clicking FORUMS from the top navigation bar. Project forums are classified according to the project category; namely transports, modules, examples, tools. There is also a section for project proposals. Create an account unless you already have one, then log in using your username and password to be able to post a message to a forum.

For Developers

Setting up your Environment

Before you start work on any MuleForge project you will need to set up your local environment.

Uploading 3rd-Party Artifacts to Maven

Sometimes your project will rely on 3rd-party jars that are not available in any maven repositories. The Uploading Artifacts to Maven page will provide details on how to add artifacts to a Maven repository.

Manage Project Releases

Before you perform release of you project on MuleForge, you should understand M2 Repositories and Download Resources so that you have clear picture of what gets deployed where.

Perform a Release

Once you've looked at this you are ready to Perform a Release. This is a simple process since Maven does most of the work for you. Just follow the steps.

Announce a Release

Finally, you are ready to [Announce a Release] to the outside world. This will put your release announcement on the front page of MuleForge as well as get syndicated with other sites.