Что делает `git notes` и как это использовать?

git notes – это механизм в Git, позволяющий прикреплять произвольные комментарии или метаданные к коммитам, объектам блоба или дерева, не меняя при этом сами объекты. Эти заметки хранятся отдельно от истории коммитов и не влияют на хеши коммитов, то есть они не изменяют SHA1 коммита.

Что делает git notes:

• Позволяет добавлять аннотации, комментарии или дополнительную информацию к коммитам без изменения их истории.
• Предназначен для сохранения метаданных, которые полезны локально или в пределах команды, но не должны становиться частью официальной истории проекта.
• Не изменяет SHA-1 коммитов.

Как это использовать:

1. Добавление заметки: Используйте команду git notes add -m "Текст заметки" <коммит>, чтобы добавить заметку к указанному коммиту. Вместо -m "Текст заметки" можно использовать -F <файл>, чтобы прочитать текст заметки из файла. Также можно просто вызвать git notes add <коммит>, что откроет редактор для ввода текста заметки.
2. Просмотр заметок: Используйте команду git notes show <коммит>, чтобы просмотреть заметки, прикрепленные к конкретному коммиту. Если коммит не указан, команда отобразит заметку текущего коммита HEAD.
3. Список всех заметок: Используйте команду git notes list, чтобы увидеть список всех существующих заметок с соответствующими хешами коммитов.
4. Редактирование заметки: Используйте команду git notes edit <коммит> для редактирования существующей заметки.
5. Копирование заметок: Используйте команду git notes copy <источник> <назначение>, чтобы скопировать заметку с одного объекта на другой (например, с одного коммита на другой).
6. Удаление заметки: Используйте команду git notes remove <коммит>, чтобы удалить заметку, прикрепленную к указанному коммиту.
7. Отправка и получение заметок: Заметки хранятся в отдельной ветке. По умолчанию эта ветка называется `refs/notes/commits`. Чтобы поделиться заметками с другими, нужно настроить репозиторий для отправки и получения этой ветки:
   • Отправка заметок: Необходимо настроить push-спецификацию. Например: git config --local remote.origin.push refs/notes/*:refs/notes/*. После этого можно отправить заметки командой git push.
   • Получение заметок: При клонировании или получении изменений из репозитория, содержащего заметки, необходимо добавить ветку заметок в fetch-спецификацию: git config --local remote.origin.fetch '+refs/notes/*:refs/notes/*'. Затем можно получить заметки командой git fetch. После этого потребуется слияние notes: git notes merge.

Примеры использования:

• Добавление заметок для себя или команды: Например, сохранение информации о багах, связанных с конкретным коммитом, или объяснение сложного кода.
• Внешние инструменты: Интеграция с внешними инструментами анализа кода или автоматизации, где результаты анализа сохраняются как заметки.
• Обзор кода: Добавление комментариев к коммитам во время обзора кода, которые не должны становиться частью официальной истории.

Важно помнить:

• Заметки не являются частью основной истории коммитов и не влияют на идентификаторы коммитов.
• Для обмена заметками с другими участниками необходимо настроить push и pull для ветки `refs/notes/commits` (или другой ветки, используемой для хранения заметок).
• Если требуется внести изменения, которые должны быть неотъемлемой частью истории коммитов, следует использовать обычные коммиты.