GitHub changelog ссылки на коммиты - PullRequest
0 голосов
/ 11 ноября 2018

В некоторых проектах есть файл 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? Если да, то как это работает? Если нет, то как эти проекты это делают?

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

1 Ответ

0 голосов
/ 11 ноября 2018

Вам нужно заглянуть под поверхность 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

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

...