Version Control of Android Studio Project via SVN

Apache Subversion (SVN)

SVN stands for Apache Subversion, a software versioning and revision control system distributed as open source under the Apache License.

In order to demonstrate the process of adding an Android Studio project into SVN,  let’s first create a new project in Android Studio and name it HelloWorldProject.
The project structure looks like this :

Now that the project has been created, let us import it into SVN. The steps for importing are :

  1. Enable Version Control : Go to VCS menu → Enable Version Control Integration

    In the popup, select Subversion from the dropdown list
  2. Add Your SVN Repository URL
    Go to VCS menu → Checkout from Version Control → Subversion

    Enter the Repository URL in the popup. This URL is the link to the SVN cloud where your repository will be stored.

    After adding the URL, select Checkout button. You will be asked to select the checkout directory (in our case it will be : ...\AndroidStudioProjects\HelloWorldProject).
  3. After the above step is completed, another popup is shown to select the checkout options like below :

    Here select the destination and go with the defaults.
    Now you will be required to enter the authentication credentials.
  4. Now that the project has been setup, it is time to add the files and folders to SVN.

    NOTE : Only those files or folders must be added to SVN that are project relevant, i.e, all the files or folders that can be generated by the IDE at the time of project initialization must be ignored from adding to SVN.

    In this case, files and folders that must be added to SVN are : Within “HelloWorldProject” folder:

    1. gradle” folder
    2. build.gradle” file
    3. gradlew” and “gradlew.bat” files
    4. settings.gradle” file
    5.” file
    6. Within “app” folder
      • libs” folder
      • src” folder
      • build.gradle” file
      •” file

        NOTE : Any other files such as, “google-services.json“, “lint“, etc that act as an integral part of the source code of the project must be added to SVN.

        NOTE : For any other module (any library sdk like Facebook sdk), same steps such as “app” folder must be followed.  

  5. The list of files and folders that must be ignored are :
    • Within “app” folder :
      •  “build” folder
      • .gradle” folder”.idea” folder
      • .svn” (hidden) folder
      • build” folder
      •” file
      • App_Name.iml” file
      •  “app.iml” file

        NOTE : “app” folder can be named something else as well (for example it can be named as “xyz”. In that case, there will be “xyz.iml” which need not be committed).

        As you can see in the above list (Ignore list), all the files or folders are generated by the IDE, (i.e., Android Studio). Hence whenever the SVN project will be downloaded and run on any other system (within Android Studio), the files or folders ignored will be generated again as per that system’s properties.

  6. In order to always ignore these files from SVN, a simple way is to add them to the Ignore list.
  7. Now commit those previously added files to SVN.
    Go to VCS menu → Commit Changes
    Whenever changes are made to the existing files in the project or new files are added, repeat the above mentioned steps to add them to SVN.

Version Control process via SVN is now complete.

Thank you for reading 🙂

Leave a Reply