Maintaining a Subversion repository can become a complex task, and implementing the right project layout from the very beginning is crucial. As Subversion doesn’t impose a strict file structure, users are free to tailor Subversion repositories to their project’s needs. Users can organize Subversion on a ‘one project per repository’ basis or create multiple projects within the same repository; and have considerable freedom when it comes to how they use Subversion’s trunk and branches. In this post, we’ll look at some guidelines and best practices on how to keep Subversion files, for users who are embarking on a new project in Subversion.
Multiple Projects: Single Repository vs. Multiple Repositories
In modern software development, it’s normal for teams to be working on multiple projects simultaneously. If this sounds like your organization, the first question you’ll need to answer is: should I set up a single repository for multiple projects, or create one repository per project? Although the experience will be slightly different for each project, there are some general benefits and drawbacks to each approach.
Single repositories are typically suited to organizations managing multiple, small projects that require cross references, cross tracking, etc.
- there is a single location where all the code is stored, even for projects you aren’t directly involved in.
- ability to reuse common libraries.
- lack of duplicated maintenance (e.g only one repository needs to be backed up.)
- the ability to move data between projects more easily, and without losing any versioning information.
- all projects share the same repository history.
- typically less administration – new projects can be created without creating a new repository, and without the help of sysadmin.
- you can delete entire projects without losing the record from Subversion.
- Subversion uses repository-global revision numbers which apply to entire trees, not to individual files. The revision number for projects will increase in accordance with the rest of the repository, even if no changes have been made to that particular project.
- unable to use unified logging (svn log command).
- branching can be complex when many folders and files are involved.
- dumping/loading one huge repository can be time-consuming.
These are typically suited to multiple large unrelated projects.
- the ability to define different access permissions, for different users.
- each project repository will have its own revision sequence.
- the version number is meaningful for all projects.
- projects have a tendency to increase in size, and numerous large projects on a single repository can become difficult to maintain. It is typically easier to manage large projects with a ‘one repository per project’ approach.
- can tailor each repository’s structure to suit a project’s unique needs. This can include branching, tagging, naming conventions, etc.
- Subversion does not support merging code between projects in different repositories, and the transplanted code will appear in the new repository with no history. This also means you cannot perform merges if you need to temporarily maintain two versions of related code.
- different projects have different mailing lists, which can be a problem if there’s cross-over between two related, but separate, projects.
There is also the potential to have more than one repository, and to group related projects within the same repository. This allows related projects to share data, and when new revisions are added to a repository, they are more likely to be relevant to everyone who uses the repository.
Once you’ve decided whether to organize your projects in a single or multiple repository structure, it’s time to plan your project layout. Putting some thought into your layout in the beginning, can help you avoid having to move files around later.
Here are some best practices for getting the most out of your project layout:
- Project root – This is the anchoring point for a project. A repository may contain one project root, or multiple roots, but each project root contains three subdirectories: /trunk, /branches, and /tags. The use of a project root is officially recommended by the Apache Subversion project.
- Trunk – This is where you should store current release code – only! Don’t muddy the trunk directory with revisions or release names.
- Branches – Use these to work on significant changes, variations of code etc, without disrupting the current release code.
- Bug fixing on a branch – Branches should be created to fix major bugs; this allows bug changes to be immediately worked on without disrupting whatever work is currently underway in the trunk/development branches.
- “Toe in the water” branches – Branches can be used as a code “sandbox” where new technology can be tested without risking the working code. If things go right, the new code can always be merged back into the trunk.
- Tags – Should be used as “code milestones” providing a snapshot of the code at specific points in its history.
- Tagging bug fix / development branches – when creating a code or bug fix branch, it’s useful to create a “pre” tag, and a “post” tag after the bug fix or code change has been completed
Ready to start a new project with Apache Subversion? Certified open source Apache Subversion binaries can be downloaded from the WANdisco website.