Как пометить или классифицировать git коммитов

Question

У меня есть ряд информации, которую я хотел бы добавить в коммит. Эта информация предназначена как для автоматических, так и для ручных процессов. Примеры включают в себя имя команды, статус (сгенерированный, разработка, конфигурация и т. Д. c) или номер заявки.

Есть ли способ добавить эту информацию в коммиты или мне нужно пометить сродни до TICKET-1234:<HASH>?

Answer 1

Существует несколько доступных опций:

• Если все, что вам нужно, это короткое, запоминающееся имя для коммита, вы можете просто пометить его, используя git tag. Объект тега указывает на фиксацию и содержит дополнительное сообщение, а сам по себе называется ref с префиксом refs/tags/. По умолчанию операции fetch и push не будут синхронизировать теги с удаленным репозиторием, если вы не передадите --tags.

• Если вам нужно хранить информацию во время создания фиксации, Вы можете включить его в конец сообщения фиксации в заголовке, подобном RFC822:

  Fixes: ticket #1234
  

  Команда git commit даже предоставляет встроенную опцию --signoff, которая автоматически добавляет один такой заголовок.

• Если вам нужно хранить более длинную информацию, которая меняется со временем, взгляните на git notes:

  Добавления, удаляет или читает примечания, прикрепленные к объектам, не касаясь самих объектов.

  По умолчанию примечания сохраняются и считываются из refs/notes/commits, но это значение по умолчанию может быть переопределено. См. Разделы ОПЦИИ, КОНФИГУРАЦИЯ и ОКРУЖАЮЩАЯ СРЕДА ниже. Если этот ссылочный номер не существует, он будет тихо создан, когда он будет вначале необходим для хранения заметки.

  Типичное использование заметок - добавить сообщение о коммите без изменения самого коммита. Примечания могут отображаться в журнале git вместе с исходным сообщением о фиксации. Чтобы отличить guish эти примечания от сообщения, хранящегося в объекте фиксации, примечания имеют отступ, как и сообщение, после строки с отступом, в которой говорится «Примечания ():» (или «Примечания:» для * 1037). *).

  Как и теги, по умолчанию ссылки с префиксом refs/notes/ не синхронизируются операциями fetch и push. Вам придется дополнительно настроить git, чтобы отслеживать их.