Recommendations

Naming job plans

Giving good names to job plans is important to easily find them when you have numerous ones.

Our recommendation for the naming of build job plans is to name after the project or module they depend on. If you use a dependency manager like Ivy or maven, following the conventions of the tool is a good idea.

To get a build job plan name from a module metadata we recommend to follow this pattern: 
[organization].[module]/[sub plan]
where the end of the organization and the beginning of the module can be merged if equal.

The sub plan can be many things depending on your needs, it can be named after branch if you have multiple plans for the same module on different branches, or depending on the frequency of the plan, or anything else.

For instance the job plans corresponding to the module org.apache.wicket wicket could be named like this: Note that org.apache.wicket and wicket have been merged in org.apache.wicket, since the org ends with the name of the module. For the module org.apache.wicket wicket-spring, the merge would be org.apache.wicket-spring.

Not only this naming is pretty easy to understand, it also allows to easily find all modules from the same organization (org.apache.wicket*), all plans on the same branch (*/2.x) or all plans for a module (org.apache.wicket/*) and even combine them (org.apache.wicket*/2.x for all plans for org.apache.wicket organization on branch 2.x).