Что такое git stash
Команда Git stash. Как прятать изменения в Git
Команда git stash предназначена для того, чтобы поместить текущие изменения, которые вы выполнили в файлах, в отдельное хранилище, и вернуть файлы к исходному состоянию. То есть git stash прячет изменения в файлах и сохраняет эти изменения отдельно, чтобы потом можно было их вернуть.
Для чего нужен git stash
Приведем пример. Например, вы выполнили какие-нибудь изменения в файлах и хотите переключиться на другую ветку, но чтобы там не было ваших текущих изменений. С помощью команды git stash можно спрятать эти изменения. Ваши изменения помещаются в отдельное хранилище — в стек, а вы можете спокойно переключиться на другую ветку.
Всё, что вы прячете с помощью git stash, попадает в отдельный список. Затем вы можете извлекать оттуда то, что вы туда спрятали — ваши «прятанья» (далее по тексту будет использоваться это слово).
Рассмотрим, как пользоваться командой git stash
Git stash
Чтобы спрятать изменения достаточно выполнить команду:
Git stash save
Например, можно сохранить изменения и добавить сообщение — подписать изменения, чтобы потом вспомнить, что именно было спрятано. В качестве сообщения, например, можно написать о том, какие именно изменения выполнены в файлах.
Git stash list
Каждое выполнение git stash или git stash save на самом деле создает отдельный коммит и сохраняет его отдельно (в стек).
Команда git stash list выводит список всех ваших прятаний:
Самые старые «прятанья» отображаются внизу списка, самые свежие сверху. Каждое прятанье имеет идентификатор с номером, например, stash@ <0>
Git stash apply
Команда git stash apply берет самое свежее прятанье ( stash@ <0>) и применяет его к репозиторию. То есть изменения, которые находятся в этом прятанье, применяются к текущему репозиторию. Это похоже на то, как вы применяете патч, только в качестве патча выступает ваше прятанье.
Если вы хотите применить какое-нибудь конкретное прятанье, можно указать его идентификатор:
Git stash pop
Было:
Стало после git stash pop:
Также можно указать идентификатор прятанья:
Git stash show
Команда git stash show показывает, какие изменения содержатся в прятанье.
Показываются изменения в файлах для самого последнего прятанья (для stash@ <0>):
Можно указать идентификатор прятанья, чтобы вывести изменения в нем:
Git stash branch
Команда git stash branch создает новую ветку с последним прятаньем, и затем удаляет последнее прятанье (как git stash pop).
Можно также указать идентификатор прятанья:
Git stash drop
Команда git stash drop удаляет самое последнее прятанье (stash@<0>).
Можно указать идентификатор прятанья, которое нужно удалить:
Git stash clear
Команда git stash clear удаляет все прятанья. Будьте внимательные перед тем, как ее выполнять, чтобы не удалить нужные данные.
Быстрый совет: изучение возможностей Git Stash
Russian (Pусский) translation by Sergey Zhuk (you can also view the original English article)
Представьте, что вы работаете над новой возможностью в проекте, в котором используется система контроля версий Git. Вы как раз делаете основные изменения в коде, когда вас просят пофиксить критичный баг. Чтобы приступить к исправлениям, вам нужна новая ветка и чистая рабочая директория. На языке основных команд Git у вас есть два варианта:
Необходимые условия
В данной статье подразумевается, что у вас уже есть установленный Git и вы владеете его основами. Вы должны свободно фиксировать изменения, создавать коммиты и работать с ветками. Так же потребуется Git репозиторий для экспериментов.
1. Сохранения изменений
Чтобы сохранить эти изменения, достаточно выполнить команду git stash без каких-либо аргументов.
Так будут сохранены ваши зафиксированные и незафиксированные изменения и очищена рабочая директория. Что даст возможность переключаться между ветками, не беспокоясь о частичных коммитах.
2. Применение сохраненных изменений
Когда вы готовы вернуться назад к незаконченной работе, выполните следующую команду, чтобы применить назад ваши сохраненные изменения:
Самый последний набор сохраненных изменений будет применен в текущей рабочей директории и можно продолжить с того момента, на котором была остановлена работа. Все на своем месте и готово.
3. Разрешение конфликтов
Нужно вручную разрешить конфликт в файле, но обычно нет необходимости коммитить изменения сразу, как после git merge конфликтов. В большинстве случаев вы продолжаете работать над незаконченной задачей, пока не подготовите осмысленный коммит. Затем можно просто добавить его в индекс и сделать коммит как обычно. Другими словами можно рассматривать конфликты git stash pop как любые другие незафиксированные изменения.
4. Стек сохранений
В большинстве случаев вам хватит перечисленных выше команд для реализации «паузы» в вашей работе. Но понимание того, каким образом изменения сохраняются и представляются внутри, открывает дверь к более продвинутому использованию.
Если прежде вы выполнили git stash три раза, то будет выведено что-то похожее на это:
Заключение
Сохранение осмысленных коммитов лежит в основе разработки с использованием Git. Осмысленные и полноценные коммиты позволяют гораздо легче перемещаться по истории проекта, обнаруживать где были допущены баги, и отменять изменения.
Хотя git stash и не является повседневной командой, но можно ее рассматривать как очень удобный инструмент для создания осмысленных коммитов. Она позволяет вам сохранять незаконченную работу и избегать фиксирования частичных снимков кода в истории проекта. Имейте это в виду, когда в следующий раз захотите сделать паузу в текущей задаче и вернуться к ней позже.
Что такое git stash
Check your version of git by running
SYNOPSIS
DESCRIPTION
Use git stash when you want to record the current state of the working directory and the index, but want to go back to a clean working directory. The command saves your local modifications away and reverts the working directory to match the HEAD commit.
The latest stash you created is stored in refs/stash ; older stashes are found in the reflog of this reference and can be named using the usual reflog syntax (e.g. stash@ <0>is the most recently created stash, stash@ <1>is the one before it, stash@ <2.hours.ago>is also possible). Stashes may also be referenced by specifying just the stash index (e.g. the integer n is equivalent to stash@
COMMANDS
Save your local modifications to a new stash entry and roll them back to HEAD (in the working tree and in the index). The part is optional and gives the description along with the stashed state.
This option is deprecated in favour of git stash push. It differs from «stash push» in that it cannot take pathspec. Instead, all non-option arguments are concatenated to form the stash message.
List the stash entries that you currently have. Each stash entry is listed with its name (e.g. stash@ <0>is the latest entry, stash@ <1>is the one before, etc.), the name of the branch that was current when the entry was made, and a short description of the commit the entry was based on.
The command takes options applicable to the git log command to control what is shown and how. See git-log[1].
Applying the state can fail with conflicts; in this case, it is not removed from the stash list. You need to resolve the conflicts by hand and call git stash drop manually afterwards.
This is useful if the branch on which you ran git stash push has changed enough that git stash apply fails due to conflicts. Since the stash entry is applied on top of the commit that was HEAD at the time git stash was run, it restores the originally stashed state with no conflicts.
Remove all the stash entries. Note that those entries will then be subject to pruning, and may be impossible to recover (see Examples below for a possible strategy).
Remove a single stash entry from the list of stash entries.
Create a stash entry (which is a regular commit object) and return its object name, without storing it anywhere in the ref namespace. This is intended to be useful for scripts. It is probably not the command you want to use; see «push» above.
Store a given stash created via git stash create (which is a dangling merge commit) in the stash ref, updating the stash reflog. This is intended to be useful for scripts. It is probably not the command you want to use; see «push» above.
OPTIONS
This option is only valid for push and save commands.
When used with the show command, show the untracked files in the stash entry as part of the diff.
This option is only valid for the show command.
Show only the untracked files in the stash entry as part of the diff.
This option is only valid for pop and apply commands.
Tries to reinstate not only the working tree’s changes, but also the index’s ones. However, this can fail, when you have conflicts (which are stored in the index, where you therefore can no longer apply the changes as they were originally).
This option is only valid for push and save commands.
All changes already added to the index are left intact.
This option is only valid for push and save commands.
This option is only valid for push command.
This option is only valid for push command.
Quiet, suppress feedback messages.
This option is only valid for push command.
Separates pathspec from options for disambiguation purposes.
This option is only valid for push command.
The new stash entry records the modified states only for the files that match the pathspec. The index entries and working tree files are then rolled back to the state in HEAD only for these files, too, leaving files that do not match the pathspec intact.
For more details, see the pathspec entry in gitglossary[7].
A reference of the form stash@ < >. When no is given, the latest stash is assumed (that is, stash@ <0>).
DISCUSSION
A stash entry is represented as a commit whose tree records the state of the working directory, and its first parent is the commit at HEAD when the entry was created. The tree of the second parent records the state of the index when the entry is made, and it is made a child of the HEAD commit. The ancestry graph looks like this:
where H is the HEAD commit, I is a commit that records the state of the index, and W is a commit that records the state of the working tree.
EXAMPLES
When you are in the middle of something, you learn that there are upstream changes that are possibly relevant to what you are doing. When your local changes do not conflict with the changes in the upstream, a simple git pull will let you move forward.
However, there are cases in which your local changes do conflict with the upstream changes, and git pull refuses to overwrite your changes. In such a case, you can stash your changes away, perform a pull, and then unstash, like this:
When you are in the middle of something, your boss comes in and demands that you fix something immediately. Traditionally, you would make a commit to a temporary branch to store your changes away, and return to your original branch to make the emergency fix, like this:
You can use git stash to simplify the above, like this:
If you mistakenly drop or clear stash entries, they cannot be recovered through the normal safety mechanisms. However, you can try the following incantation to get a list of stash entries that are still in your repository, but not reachable any more:
Припрятывание и очистка
Операция stash берет изменённое состояние вашего рабочего каталога, то есть изменённые отслеживаемые файлы и проиндексированные изменения, и сохраняет их в хранилище незавершённых изменений, которые вы можете в любое время применить обратно.
Команда git stash save не исчезнет в ближайшее время, поэтому не беспокойтесь о её внезапной пропаже. Но вы можете начать переход на push для использования новой функциональности.
Припрятывание ваших наработок
Теперь вы хотите сменить ветку, но пока не хотите фиксировать ваши текущие наработки; поэтому вы припрячете эти изменения. Для того, чтобы припрятать изменение в выделенное для этого специальное хранилище, выполните git stash или git stash push :
Теперь вы можете увидеть, что рабочая копия не содержит изменений:
В данный момент вы можете легко переключать ветки и работать в любой; ваши изменения сохранены. Чтобы посмотреть список припрятанных изменений, вы можете использовать git stash list :
Как видите, Git восстановил в файлах изменения, которые вы отменили ранее, когда прятали свои наработки. В данном случае при применении отложенных наработок ваш рабочий каталог был без изменений, а вы пытались применить их в той же ветке, в которой вы их и сохранили; но отсутствие изменений в рабочем каталоге и применение их в той же ветке не являются необходимыми условиями для успешного восстановления припрятанных наработок. Вы можете припрятать изменения, находясь в одной ветке, а затем переключиться на другую и попробовать восстановить эти изменения. Также при восстановлении припрятанных наработок в вашем рабочем каталоге могут присутствовать изменённые и незафиксированные файлы — Git выдаст конфликты слияния, если не сможет восстановить какие-то наработки.
Необычное припрятывание
Создание ветки из припрятанных изменений
Это удобное сокращение для того, чтобы легко восстановить припрятанные изменения и поработать над ними в новой ветке.
Очистка рабочего каталога
Наконец, у вас может возникнуть желание не прятать некоторые из изменений или файлов в вашем рабочем каталоге, а просто избавиться от них. Команда git clean сделает это для вас.
Одной из распространённых причин для этого может быть удаление мусора, который был сгенерирован при слиянии или внешними утилитами, или удаление артефактов сборки в процессе её очистки.
Ниже выполнена команда очистки в интерактивном режиме.
Таким образом, вы можете просмотреть каждый файл индивидуально или указать шаблоны для удаления в интерактивном режиме.
Stash: знакомимся со «скрытым» функционалом Git
Перевод статьи «Learn the hidden feature in Git — Stash».
В этой статье мы разберем такую функцию Git, как stash. Начнем с разбора самого термина. Что такое stash? В переводе с английского это слово означает «припрятывать», «тайник», «запас». Применительно к Git смысл слова сохраняется. При помощи команды git stash мы убираем (временно) изменения из рабочей директории, «прячем» их.
Когда имеет смысл использовать git stash и как это делается?
Команда git stash пригодится вам в случаях, когда вы не хотите коммитить недоделанную работу и планируете вернуться к ней позже.
Предположим, у нас есть git-репозиторий, а в нем два файла: index.html и feature-1.js.
В той же ветке master в файле feature-2.js ведется работа над новой фичей. Фича еще не готова, вы как раз ею занимаетесь.
Внезапно вам звонит тимлид и сообщает, что в feature 1 есть проблема, блокирующая работу другого члена команды. Вы должны немедленно внести правку, чтобы разблокировать вашего коллегу.
Для этого вам нужно внести изменения в файл feature-1.js, но при этом не запушить feature-2.js (потому что вы еще не закончили работу над feature 2 ).
В описанной выше ситуации вам нужно проделать следующие шаги.
1. Добавьте файлы, работу над которыми вы еще не закончили, в стейджинг. Это делается при помощи команды git add :
2. При помощи следующей команды уберите эти файлы из рабочей директории в stash:
Вы успешно исправили проблему в файле feature-1.js.
Но как теперь вернуться к работе над feature-2.js?
Извлекаем файлы из stash
2. Идентификатор нашего «тайника» — stash@ <0>. Чтобы применить изменения из этого «тайника» (т. е. вернуть файлы в рабочую директорию), выполните следующую команду:
3. После выполнения этой команды вы увидите следующий вывод:
Вероятно, вы удивитесь, но «тайник» все еще на месте. Мы вернули файл feature-2.js в рабочую директорию, так почему же он все еще в stash? Дело в том, что «тайник» нужно очистить.
Как очистить stash?
Есть два способа очистить примененный stash.
Можно удалить «тайник» по id. Следующая команда позволит удалить из списка «тайников» (stash list) конкретный stash:
Или можно очистить вообще весь список. Внимание: следующая команда удалит все «тайники» из списка.
От редакции Techrocks. Под оригинальной статьей было несколько полезных комментариев. Мы решили перевести их тоже.
2. При помощи команды git stash pop можно возвращать из stash последний добавленный тайник и одновременно удалять его из стека stash.
А если добавить индекс, можно проделать то же самое для любого «тайника» по вашему выбору ( git stash pop stash@