RubyMine 2019.2 Help

Set up a Git repository

Check out a project from a remote host (clone)

RubyMine allows you to check out (in Git terms clone) an existing repository and create a new project based on the data you've downloaded.

  1. From the main menu, choose VCS | Checkout from Version Control | Git, or, if no project is currently opened, choose Checkout from Version Control | Git on the Welcome screen.

  2. In the Clone Repository dialog, specify the URL of the remote repository you want to clone (you can click Test to make sure that connection to the remote can be established).

  3. In the Directory field, specify the path where the folder for your local Git repository will be created into which the remote repository will be cloned.

  4. Click Clone. If you want to create a RubyMine project based on the sources you have cloned, click Yes in the confirmation dialog. Git root mapping will be automatically set to the project root directory.

    If your project contains submodules, they will also be cloned and automatically registered as project roots.

Put an existing project under Git version control

Apart from cloning a remote repository, you can create a local repository based on an existing project's sources.

Import an entire project into a single Git repository

  1. Open the project that you want to put under Git.

  2. From the main menu, choose VCS | Enable Version Control Integration.

  3. In the dialog that opens, select Git from the list and click OK.

Import different project modules into different Git repositories

  1. Open the project that you want to put under Git.

  2. From the main menu, choose VCS | Import into Version Control | Create Git Repository.

  3. In the dialog that opens, specify the directory where a new Git repository will be created.

Add files to the local repository

After you have initialized a Git repository for your project, you need to add project data to it.

Open the Version Control tool window Alt+9 and switch to the Local Changes tab.

Put any files in the Unversioned Files changelist under version control by pressing Ctrl+Alt+A or selecting Add to VCS from the context menu. You can either add the entire changelist, or select separate files.

You can also add files to your local Git repository from the Project tool window. Select the files you want to add, and press Ctrl+Alt+A or choose Git | Add from the context menu.

If you have enabled Git integration for your project, RubyMine suggests to add each newly created file under Git version control (you can change this behavior in the Settings Preferences dialog Ctrl+Alt+S under Version Control | Confirmation). If you want certain files to always remain unversioned, you can configure Git to ignore them.

Exclude files from version control (ignore)

Sometimes you may need to leave certain files unversioned. These can be VCS administration files, artifacts of utilities, backup copies, and so on. You can ignore files through RubyMine, and the IDE will not suggest adding them to Git and will highlight them as ignored.

Git lets you list ignored file patterns in .gitignore files in the VCS root directory and its subdirectories. If there is no .gitignore file in the VCS root directory, you can right-click anywhere in the Project window, choose New | File and type .gitignore in the New File dialog.

Note that once you've added a file to Git version control, ignoring it will have no effect. You need to remove it from the Git repository first.

Add files to .gitignore

  1. Inspect your VCS root directory to check if there is the .gitignore file in it.

    To create the .gitignore file, you can right-click anywhere in the Project window, choose New | File and type .gitignore in the New File dialog.

  2. Locate the unversioned file or folder you want to ignore in the Project view, right click it and select Git | Add to .gitignore.

    This action is also available from the context menu of a file in the Local Changes view of the Version Control tool window.

If you need to exclude files by a certain pattern, or files of a certain type, you can edit the .gitignore file directly. See .gitignore patterns format

Check project status

RubyMine allows you to check the status of your local working copy compared to the repository version of the project. It uses specific colors to let you see which files have been modified, which new files have been added to the VCS, and which files are not being tracked by Git.

Open the Version Control tool window Alt+9 and switch to the Local Changes tab:

file status
  • The Default changelist shows all files that have been modified since you last synchronized with the remote repository (highlighted in blue), and all new files that have been added to the VCS but have not been committed yet (highlighted in green).

  • The Unversioned Files changelist shows all files that have been added to your project, but that are not being tracked by Git.

If there were conflicts during a merge that were not resolved, the Merge Conflicts node will appear in the corresponding changelist with a link to resolve them.

For more info on changelists, see Group changes into different changelists.

Track changes to a file in the editor

You can also track changes to a file as you modify it in the editor. All changes are highlighted with change markers that appear in the left gutter next to the modified lines, and show the type of changes introduced since you last synchronized with the repository. When you commit changes to the repository, change markers disappear.

The changes you introduce to the text are color-coded:

  • marker for a newly added line line added.

  • marker for a modified line line changed.

When you delete a line, the following marker appears in the left gutter: the deleted line marker.

You can manage changes using a toolbar that appears when you hover the mouse cursor over a change marker and then click it. The toolbar is displayed together with a frame showing the previous contents of the modified line:

the modified line marker

You can rollback changes by clicking the Revert icon (note that all changes to the file since its last revision will be reverted, not just the current line), and explore the differences between the current and the repository version of the current line by clicking the Show diff icon.

Instead of reverting the whole file, you can copy any part of the contents of this popup and paste it into the editor.

Add a remote repository

To be able to collaborate on your Git project, you need to configure remote repositories that you fetch data from and push to when you need to share your work.

If you have cloned a remote Git repository, for example from GitHub, the remote is configured automatically and you do not have to specify it when you want to synchronize with it (in other words, when you perform a pull or a push operation). The default name Git gives to the remote you've cloned from is origin.

However, if you created a Git repository based on local sources, you need to add a remote repository for other contributors to be able to push their changes to it, and for you to be able to share the results of your work.

Define a remote

  1. Create an empty repository on any Git hosting, such as Bitbucket or GitHub.

  2. Invoke the Push dialog when you are ready to push your commits by selecting VCS | Git | Push from the main menu, or press Ctrl+Shift+K.

  3. In the dialog that opens, specify the remote name and the URL where it will be hosted, and click OK.

In some cases, you also need to add a second remote repository. This may be useful, for example, if you have cloned a repository that you do not have write access to, and you are going to push changes to your own fork of the original project. Another common scenario is that you have cloned your own repository that is somebody else's project fork, and you need to synchronize with the original project and fetch changes from it.

Add a second remote

  1. From the main menu, choose VCS | Git | Remotes. The Git Remotes dialog will open.

  2. Click the Add add button on the toolbar or press Alt+Insert.

  3. In the dialog that opens, specify the remote name and URL and click OK.


To edit a remote (for example, to change the name of the original project that you have cloned), select it in the Git Remotes dialog and click the Edit edit button on the toolbar, or press Enter.

To remove a repository that is no longer valid, select it in the Git Remotes dialog and click the Remove remove button on the toolbar, or press Alt+Delete.

Learn more from this video:

Last modified: 5 September 2019