Ссылки журнала изменений GitHub на коммиты

В некоторых проектах есть файл CHANGELOG.md, в котором каждая версия ссылается на диапазон коммитов, сделанных для этой версии. Например, вот этот. Похоже, что эти ссылки каким-то образом генерируются автоматически, потому что уценка содержит только [1.0.0] там, где визуализированный документ имеет ссылку на https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0....v1.0.0.

Как это работает? Я пытался сделать что-то подобное в своем собственном проекте, но визуализированный документ просто сказал [1.0.0]; ссылка не сгенерировалась.

Предположительно, это как-то связано с тегами, которые следуют аналогичному шаблону (v1.0.0), но когда я попытался создать аналогичные теги в своем проекте, это все равно не сработало.

Я также не смог найти ссылки на это в справке GitHub или где-либо еще в этом отношении.

Это действительно (недокументированная?) функция GitHub? Если да, то как это работает? Если нет, то как эти проекты это делают?

Обратите внимание: меня не интересует автоматическое создание журнала изменений из таких коммитов, как этот проект< /а> делает. Меня просто интересует механика этих гиперссылок.


person jqno    schedule 11.11.2018    source источник


Ответы (1)


Вам нужно заглянуть под поверхность Markdown, это простой трюк, который он проделал, используя функцию сравнения файлов для сравнения тегов.

Если вы посмотрите на файл RAW , вы должны заметить, что внизу он добавил ссылки на каждый номер версии, которому назначена ссылка для сравнения.

## [1.0.0] - 2017-06-20

[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0

В красивом режиме вы увидите ссылку на страницу сравнения.

person Praveen Premaratne    schedule 11.11.2018