Shelve or stash changes

If you want to work both with stashes and shelves, you can combine the Stash and the Shelf tabs into one.

1. Press CtrlAlt0S to open settings and select Version Control | Git | Stash.

2. Enable the Combine stashes and shelves in one tab option.

   In the combined tab, you will be able to work both with stashed and shelved changes.

   

1. In the Commit tool window Alt00, right-click the files or the changelist you want to shelve and select Shelve Changes from the context menu.

2. In the Shelve Changes dialog, review the list of modified files.

3. 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 the file or changelist you want to shelve and click Shelve Silently on the toolbar or press CtrlShift0H. The name of the changelist containing the changes you want to shelve will be used as the shelf name.

To avoid ending up with numerous shelves with the same name (such as Default, for example), you can drag a file or a changelist from the Commit tab to the Shelf tab of the Commit tool window, wait for a second until it's activated, and edit the new shelf name after releasing the mouse button.

tip

If you need to copy your changes to a shelf without resetting local changes, press CtrlShift0A and look for the Save to Shelf action.

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.

1. In the Shelf tab, select the changelist or the files you want to unshelve.

2. Press CtrlShift0U or choose Unshelve from the context menu of the selection.

3. In the Unshelve Changes dialog, specify the changelist you want to restore the unshelved changes to in the Name field. You can select an existing changelist from the list or enter the name for a new changelist to be created. You can enter the description of the new changelist in the Comment field (optional).

   If you want to make the new changelist active, select Set active. Otherwise, the current active changelist remains active.

4. If you want GoLand to save the context of a task associated with the new changelist when deactivated and restore the context when the changelist becomes active, select the Track context option (refer to tasks and contexts for details) .

5. 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, added to another changelist, and marked as applied. They will not be removed completely until deleted explicitly by selecting Delete from the context menu.

   note

   If you've deleted unshelved files by accident, you can view and restore them from the Recently Deleted node.

6. Click OK. If conflicts occur between the patched version and the current version, resolve them as described in Resolve Git 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 Unshelve Silently on the toolbar or press CtrlAlt0U. The unshelved files will be moved to the active pending changelist.

You can also drag a file or a changelist from the Shelf tab to the Commit tab to unshelve it silently. If you drag it holding the Ctrl key, it will be copied to the Commit tab but also kept in the shelf.

1. In the Shelf view, select the changelist that contains the changes you do not want to keep anymore.

2. Right-click the changelist and choose Delete from the context menu or press Delete.

GoLand lets you reapply unshelved changes if necessary. All unshelved changes can be reused until they are removed explicitly by selecting Delete from the context menu.

1. Click Show and make sure that the Already Unshelved option is enabled.

2. Select the files or the shelf you want to restore.

3. From the context menu of the selection, choose Restore.

You can import patches created inside or outside GoLand and apply them as shelved changes.

1. In the Shelf view, choose Import Patches from the context menu.

2. In the dialog that opens, select the patch file to apply. The selected patch appears in the Shelf tab as a shelf.

3. Select the newly added shelf with the patch and choose Unshelve Changes from the context menu of the selection.

It may be useful to configure GoLand to always shelve base revisions of files that are under Git version control.

1. Press CtrlAlt0S to open settings and then select Version Control | Shelf.

2. 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 the shelf leads to conflicts. If it is disabled, GoLand 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).

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.

1. Press CtrlAlt0S to open settings and then select Version Control | Shelf.

2. Click Change Shelves Location and specify the new location in the dialog that opens.

3. If necessary, select Move shelves to the new location to move existing shelves to the new directory.

1. In the Commit tool window Alt00, right-click to open the context menu and select Git | Stash Changes.

   

2. In the Stash dialog that opens, select the appropriate Git root and make sure that the correct branch is checked out.

3. In the Message field describe the changes you are about to stash.

4. To stash local changes and bring the changes staged in the index to your working tree for examination and testing, select the Keep index option.

5. Click Create Stash.

   The stashed changes will be moved to the Stash tab next to the Commit tab in the same Commit tool window.

1. In the Commit tool window Alt00, open the Stash tab.

   

2. Select the stash you want to apply from the list of stashes.

   If you want to check the changes in the stashed files, double-click any file from the list to open the diff of stashes.

3. • Click Apply to apply the selected stash and keep it in the list.

   • Сlick Pop to apply the selected stash and remove it from the list.

4. You can create a new branch on the basis of the selected stash instead of applying it to the branch that is currently checked out.

   Right-click the stash to open the context menu and select Unstash.

   Type the name of that branch in the As new branch field.

   To apply stashed index modifications as well, select the Reinstate Index option.

   Click Apply Stash.

To remove a stash, select it in the list, right-click to open the context menu and select Drop. To remove all stashes, select Clear.