Shelving and Unshelving Changes
Shelving is temporarily storing pending changes you have not committed yet. This is useful, for example, if you need to switch to another high priority task and you want to set your changes aside to work on them later.
With RubyMine, you can shelve both separate files and entire changelists.
Once shelved, a change can be applied as many times as you need by unshelving and subsequently restoring it on the shelf.
Put changes to a shelf
- Open the Version Control tool window (Alt+9) and switch to the Local Changes tab.
- Select the files or a changelist you want to put to a shelf. On the main Version Control menu or on the context menu of the selection, choose Shelve changes.
- In the Shelve Changes dialog, review the list of modified files.
- In the Commit Message field, enter the name of the shelf to be created and click the Shelve Changes button.
You can also shelve changes silently, without displaying the Shelve Changes dialog. To do this, select a file or a changelist you want to shelve, and click the Shelve Silently icon on the toolbar, or press Ctrl+Alt+H. The name of the changelist containing the changes you want to shelve will be used as the shelf name.
Unshelving is moving postponed changes from a shelf to a pending changelist. Unshelved changes can be filtered out from view or removed from the shelf.
- In the Shelf tab of the Version Control tool window, select a changelist or files you want to unshelve.
- Press Ctrl+Shift+U or choose Unshelve from the context menu of the selection.
- In the Unshelve Changes dialog that opens, specify the changelist you want to restore the unshelved changes to in the Name field. You can select an existing changelist from the drop-down list or type a name for a new changelist to be created containing the unshelved changes. You can enter the description of the new changelist in the Comment field (optional).
If you want to make the new changelist active, select the Set active option. Otherwise, the current active changelist remains active.
- If you want RubyMine to preserve the context of a task associated with the new changelist on its deactivation and restore the context then the changelist becomes active, select the Track context option (see Managing Tasks and Contexts for details).
- If you want to remove the changes you are about to unshelve, select the Remove successfully applied files from the shelf option. The unshelved files will be removed from this shelf and added to another changelist and marked as applied. They will not be removed completely until deleted explicitly by clicking the icon on the toolbar, or selecting Clean Already Unshelved from the context menu.
- Click OK. If conflicts occur between the patched version and the current version, resolve them as described in Resolving Conflicts.
You can also unshelve changes silently, without displaying the Unshelve Changes dialog. To do this, select a file or a changelist you want to unshelve, and click the Unshelve Silently icon on the toolbar, or press Ctrl+Alt+U. The unshelved files will be moved to the active pending changelist.
Restore unshelved changes
RubyMine lets you reapply unshelved changes if necessary. All unshelved changes can be reused until they are removed explicitly by clicking the icon on the toolbar, or selecting Clean Already Unshelved from the context menu.
To restore applied changes on the shelf do the following:
- Make sure that the Show Already Unshelved toolbar option is enabled.
- Select the files or the shelf you want to restore.
- On the context menu of the selection, choose Restore.
Apply external patches
You can import patches created inside or outside RubyMine and apply them as shelved changes.
- In the Shelf tab of the Version Control tool window, choose Import Patches from the context menu.
- In the dialog that opens, select the patch file to apply. The selected patch appears in the Shelf tab as a shelf.
- Select the newly added shelf with the patch and choose Unshelve Changes from the context menu of the selection.
Automatically shelve base revision
It may be useful to configure RubyMine to always shelve base revisions of files that are under Git version control. To do this, open the Settings dialog (Ctrl+Alt+S), select the Version Control | Shelf node on the left and select the Shelve base revisions of files under distributed version control systems option.
If this option is enabled, the base revision of files will be saved to a shelf that will be used during a 3-way merge if applying a shelf leads to conflicts. If it is disabled, RubyMine will look for the base revision in the project history, which may take a while; moreover, the revision that the conflicting shelf was based on may be missing (for example, if the history was changed as a result of the rebase operation).
Change the default shelf location
By default, the shelf directory is located under your project directory. However, you may want to change the default shelf location. This can be useful, for example, if you want to avoid deleting shelves accidentally when cleaning up your working copy, or if you want to store them in a separate repository allowing shelves to be shared among your team members.
- Open the Settings dialog (Ctrl+Alt+S) and select the Version Control | Shelf node on the left.
- Click the Change Shelves Location button and specify the new location in the dialog that opens.
- If necessary, select the Move shelves to the new location option to move existing shelves to the new directory.
Watch this video tutorial on how to benefit from shelves to be able to switch to a different task without losing unfinished work: