如何在github上处理markdown文档的发布

Question

我们有一个小组开发的元数据约定文档，用于在https://github.com/ugrid-conventions/ugrid-conventions存储为github-flavored markdown的特定海洋模型组 现在我们想在版本1.0“发布”此降价文档的当前版本（并继续开发未来版本的约定）。

我知道github有发行版，但是我们不想要包含markdown文档的zip文件，我们只需要一个“1.0版”降价文档。我们还可以保留更改，以便人们可以看到相对于以前版本的变化。

我们是否应该将现有文档ugrid-conventions.md复制到ugrid-conventions_v1.0.0.md，还是有更好的方式？

Answer 1

我建议为每个版本创建一个tag。标签自动列在GitHub的Releases页面上（事实上，每个Release都与一个标签相关联），您还可以直接链接到标记提交中的文件。例如，如果您创建了名为v1.0的标记，则可以将人员发送到https://github.com/ugrid-conventions/ugrid-conventions/blob/v1.0/ugrid-conventions.md以查看该文件的1.0版本。