首页 > 解决方案 > 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 的(未记录的?)功能吗?如果是,它是如何工作的?如果没有,这些项目是如何做到的?

请注意,我对像这个项目那样从提交中自动生成变更日志不感兴趣。我只是对这些超链接的机制感兴趣。

标签: githubauto-generatechangelog

解决方案


您需要深入了解 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

使用漂亮模式,您会看到比较页面的链接。


推荐阅读