Documentation (beta)

Projects

A SVN repository or project is represented as a project in SyncRelease. The choice of such naming is rooted in history of SyncRelease which was originally written for web development, although it can now be used for other than web developments.



Pre-requisite requirements for SVN repository


First, before adding your existing SVN repository to SyncRelease you will need to make sure the repository is in the following structure, which is often described as an industry-wise best-practice.

/branches
/tags
/trunk

And it should have no any prior release tags such as syncrelease-RLE-1 created by SyncRelease in /tags directory. If there are ones, please remove them first before adding your repository to be managed by SyncRelease.



How to add a project?


When you want to add a SVN repository to SyncRelease, follow these steps below:


  • Go to Projects page by clicking on Projects tab on the main menu
../_images/sites-fig1.png


  • Click on Add project link on the left side of the page
../_images/sites-fig2.png


  • Next, fill in the project name and its SVN repository path and login credentials that will be used by SyncRelease to create release tags.

../_images/sites-fig3b.png


  • Click on Create button and next you should see your new project coming up on the project list page.
../_images/sites-fig4.png


Supported SVN repository access protocols


When you add a SVN repository to SyncRelease, the following protocols are supported as a path to SVN repository:

svn protocol            ==> Example: svn://localhost/mywebsite
file system protocol    ==> Example: file:///var/svn-repositories/mywebsite
http protocol           ==> Example: http://svn.mycompany.com/mywebsite
https protocol          ==> Example: https://svn.mycompany.com/mywebsite


How to edit an existing Project?


To edit an existing Project or repository in SyncRelease, do the followings:


  • Go to project list page by clicking on Projects tab on the main menu
  • Click on the project you want to edit/change.
  • Once you are on the details page for the project you want to edit, click on Edit Project link
  • Then, you can update your project as necessary.
../_images/sites-fig5.png


How to delete an existing Project?


To delete an existing project or repository in SyncRelease, do the followings:


  • Go to project list page by clicking on Projects tab on the main menu
  • Then click on Delete link for the project you want to delete

NOTE : deleting a project will also delete all releases you have created for that particular project