Ruby on Rails Subversion Prep Tool

README                                                             rorsvnprep

This gem provides some aids for starting new Rails projects that will be managed with the subversion SCM system. The command line utility provides will create a new project, perform initial modifications and even the initial subversion specific actions to get your project under subversion management quickly and with a minimum of fuss.

This gem provides a simple command-line tool that handles everything:

rorsvnprep

It is recommended that you create an alias for this command to save you on typing. On most systems you can alias rorsvnprep to rsp without interfering with anything else, but double-check on your own system before deciding on an alias.

Using rorsvnprep

The rorsvnprep command can accept a number of command-line parameters that determine its behavior. At the very minimum you need to supply it with a project name, just like you would the rails command. Under the hood rorsvnprep actually calls the rails command and then performs some basic preparations.

If all you provide is the project name then rorsvnprep simply generates .cvsignore files for your project as described later and trims a few extraneous directories and files. If, however, you also provide a repository URI via the ‘–svn [repos]’ switch; then rorsvnprep will actually perform an initial import of your project and perform svn propset calls in place of using .cvsignore files. You may supply a password to rorsvnprep to further automate things, if you haven’t setup shared-key authentication, via the ‘–password [pass]’ switch.

Assuming you supply nothing else, rorsvnprep will attempt to import your project to ‘/<projectname>/trunk’ within the supplied svn repository. However, you can change this behavior by supplying an alternate location via the ‘–rpath [path]’ switch. When finished importing and setting up your project rorsvnprep will leave you with a good working copy to begin development with.

-------------------
Command-Line Syntax
-------------------

rorsvnprep projectname [--svn svn://example.org/path/to/repos]
                       [--password pass]
                       [--rpath /custom/trunk]