Руководство Git и changelog

Я нуб с git и я хотел бы знать наилучшую практику создания тегов и создания/mantain журнала изменений.

до сих пор я всегда создавал readme.md и вручную укажите (в разделе "журнал изменений") наиболее важную функцию

например:

версия 1.0.1

  • изменен макет дома
  • добавил слайд-шоу в галерее
  • etc..

Как я могу создать журнал изменений (возможно, в формате markdown) с этими характеристиками?

  • заголовок изменений на основе персонализированного заголовка / тегов title / date
  • изменения на основе тегов или совершает

У меня пока нет четкой идеи, поэтому предложения aprreciate

спасибо заранее :)

9
bitbucket changelog git markdown

3 ответов

пока нет каких-то общих рекомендаций. Но многие хорошие правила объясняются на сохранить изменения.

и как они говорят:

Не позволяйте своим друзьям сбрасывать журналы git в changelogs.

и я полностью с этим согласен.

вот почему я создал Генератор Изменений GitHub что генерирует изменения по всем этим правилам.

на самом деле он работает с только GitHub, но это хороший пример того, как должен выглядеть журнал изменений.

он автоматически генерирует журнал изменений из ваших тегов, проблем, меток и запросов на вытягивание.

например: этот список был создан этот скрипт: чейнджлог.МД

изменений

1.2.5 (2015-01-15)

Полный Список Изменений

реализованные улучшения:

  • используйте milestone, чтобы указать, в какой версии была исправлена ошибка #22

исправлены ошибки:

  • ошибка при попытке создать журнал для репо без тегов #32

слился запросы:

  • класс PrettyPrint со строчной 'ПП' #43 (schwing)

  • поддержка enterprise github через параметры командной строки #42 (glenlovett)

8

Я предлагаю вам по-прежнему вручную описать изменения в changelog.

Tough, вы можете ссылаться на сгенерированные изменения через GitHub diff. Например, в changelog: https://github.com/rspec/rspec-core/blob/master/Changelog.md

и дифф: https://github.com/rspec/rspec-core/compare/v2.14.2...master

вы можете посмотреть вокруг в репозиториях некоторых других проектов с открытым исходным кодом, где много хороших практики можно найти.

2

вероятно, мой Asnwer слишком поздно, но теперь я использую удивительный рубиновый камень, он читает ваш журнал git и разбивается на теги, а вывод записывается в markdown, посмотрите

https://github.com/kebab-project/katip

2