Knowledgebase

Search:     Advanced search

Surround SCM IntelliJ IDEA and WebStorm Integration

Article ID: 757  |  Last updated: 23 Jun, 2016

Surround SCM supports integration with IntelliJ IDEA and WebStorm. See Surround SCM Third-Party Integrations for supported platforms and versions.

This article includes information about installing the integration plug-insharing projectsperforming Surround SCM actions, configuring Surround SCM preferences, and troubleshooting.

Note: Steps for configuring and using the IntelliJ IDEA and WebStorm integrations are the same.

Installing the plug-in

  1. In IntelliJ IDEA or WebStorm, choose File > Settings. The Settings dialog box opens.
  2. Select the Plugins category.
  3. Click Browse repositories. The Browse Repositories dialog box opens.
  4. Select the Surround SCM plug-in and then click Install plugin. You are prompted to confirm the installation.
  5. Click Yes. The plug-in is downloaded and installed.
  6. Click Close to close the Browse Repositories dialog box.
  7. Click Apply in the Settings dialog box to save the changes. You are prompted to restart IntelliJ IDEA or WebStorm.
  8. Click Restart.

Sharing projects

Before you can perform Surround SCM actions from IntelliJ IDEA or WebStorm, you need to associate the project with Surround SCM.

  1. Open the project in IntelliJ IDEA or WebStorm.
  2. Select the project root node and choose VCS > Enable Version Control Integration. The Enable Version Control Integration dialog box opens.
  3. Select Surround SCM and click OK.
  4. Right-click the project root node and choose Surround SCM > Work Online. You are prompted to associate the project with Surround SCM.
  5. Click Fix. The Surround SCM Repository Browser opens.

    Note: Click Ignore if you do not want to associate the project, but want to be prompted when you open another project. Click Ignore All if you do not want to associate any projects when this instance of IntelliJ IDEA or WebStorm is open.

  6. Select the repository to associate the project with or click Create Repository to create a new repository for the project.

    Note: If an existing repository is selected, the working directory must be the project directory. Right-click the repository and choose Set Working Directory to change the working directory. Creating a new repository automatically assigns the project directory as the working directory.

  7. Click OK to close the repository browser. The integration is ready to use.

Performing Surround SCM actions

To perform a Surround SCM action, select it from the Version Control > Surround SCM menu. You can also right-click a file and choose an action from the Surround SCM menu.

 Action  Use to:
Add Add files to Surround SCM. You cannot add packages, but you can add multiple files to Surround SCM at the same time.
Get Manually select files to retrieve local copies to the working directory.
Get Changes Retrieve local copies of all files in a project to the working directory.
Check Out Check out the selected files to make changes to them.
Undo Check Out Discard any changes made to a checked out file and remove the checked out status.
Check In Check in updated files and make changes available to other users.
History View the file history.
Properties View the file properties.
Differences Compare the local copy of a file in your working directory with the current version in Surround SCM or a local project folder with the repository in Surround SCM.
Rename Rename files in Surround SCM and the project. Files are renamed in Surround SCM first before you are prompted to rename them in the project. If you do not rename project files, you cannot work with them unless you add them to Surround SCM or manually rename them.
Refresh File Status Update the file status. For example, if you check out a file from the Surround SCM Client, it is not displayed as checked out in IntelliJ IDEA or WebStorm until you refresh the file status.
Remove Remove files from Surround SCM and the project.

Disconnecting a project

To work offline, you must manually disconnect projects from source control. Files are not removed or destroyed from Surround SCM when you disconnect a project.

  1. Select the project root node.
  2. Choose File > Settings.
  3. Set the version control provider for the project to None and click OK.

To remove all references to Surround SCM, remove the hidden files that Surround SCM uses to keep track of files in working directories.

  1. Close IntelliJ IDEA or WebStorm.
  2. Browse to the project directory.
  3. Locate and delete the .MySCMServerInfo file.
  4. Browse to any subdirectories or other directories where files used by the project exist and delete the .MySCMServerInfo files.

Note: When you restart IntelliJ IDEA or WebStorm, files may still have a lock icon next to them because they are read-only. The local icon is not removed until the read-only attribute is removed from the files. See the IntelliJ IDEA or WebStorm help for information about changing file read-only status.

Configuring Surround SCM preferences

You can configure options for the Surround SCM integration, such as to automatically add or remove files based on changes in the project and to enable prompting to check out files before editing.

  1. Choose File > Settings.
  2. Expand the Version Control node and select Surround SCM. The Surround SCM preferences are displayed.
  3. Make any changes and click OK.

Troubleshooting

Surround SCM is not displayed in the Version Control menu, Version Control settings, or file shortcut menu

Following are common causes and solutions.

  • The Surround SCM plug-in is not installed. Install it to use the integration.
  • You are using an unsupported version of IntelliJ IDEA or WebStorm. Upgrade to a supported version.

Most Surround SCM actions are not enabled

Following are common causes and solutions.

  • The project is not configured correctly. Make sure the project is configured to point to a valid Surround SCM branch and repository on the server you are connected to.
  • IntelliJ IDEA or WebStorm cannot connect to the Surround SCM Server. Make sure the Surround SCM Server is running and your username and password are correct.
  • The local .MySCMServerInfo file is out of sync. This file is used to determine where to look for files in Surround SCM. Make sure the .MySCMServerInfo file data in the project files directory points to the correct branch and repository. If the file points to an incorrect branch or repository, delete it and then get the project from the Surround SCM Client to regenerate it.  

Cannot add files to Surround SCM

Following are common causes and solutions.

  • The Surround SCM integration is not configured correctly. Make sure the project points to a valid branch and repository and the .MySCMServerInfo file exists.
  • The project configuration points to the wrong branch. This can be an issue if you maintain the local project files in Surround SCM and then branch the repository that contains the server project files. Configure the version control settings for the project to point to the correct branch and then add the files to Surround SCM.
Article ID: 757  |   Last updated: 23 Jun, 2016
Tags
IntelliJ IDEA WebStorm

Prev   Next
Integrating Surround SCM with IDEs     Upgrading the Surround SCM Visual Studio Integration