关于github|gitlab例子中的更新日志的所有内容

594 阅读3分钟

在软件应用程序开发中,代码存储在代码库中,如git,bitbucket,应用程序中的每个功能都会提交更改日志和版本号。

在应用程序的发布过程中,应用程序的版本会增加

例如,windows被发布给最终用户的版本是10,11,每个版本都包含了一些功能。

什么是变更日志?

Changelog 是一个文本文件,包含了你对项目每个版本所做的所有修改的日志摘要。它也被称为release notes

该项目是软件或应用程序或开源产品。

它包含日期和版本号,并包含更改的日志,可以按模块或功能分组。这个文件没有标准的格式,但你可以遵循某些规则。

如何写更新日志?

你可以在每个版本的更新日志中添加不同的变化。

  • Added:这一部分包含发布的新功能。
  • Changed:它包含对现有功能所做的改变。
  • Deprecated: 在未来删除的变化。
  • Removed: 移除的功能。
  • Fixed:任何错误的修复。
  • Security: 安全问题在此声明

更新日志的原则和特点

  • 由用户和贡献者使用,不用于机器。
  • 它包含发布日期
  • 摘要日志按功能分组
  • 显示版本号,最新版本显示在前面
  • 这个文件可以创建为.txt.md.rst 后缀。

git变更日志生成器

有很多生成器可以生成更新日志

更新日志格式示例文件

变更日志文件可以用markdown 编辑器创建,扩展名为**.md**的gitlabgithub

通常情况下,软件发布过程中会遵循语义版本,最高版本在先。

以下是更新日志的格式和摘要

All summary of changes are written here

Highest version comes first

[2.0.0] - 2021-10-02
Here we write upgrading notes for brands. It's a team effort to make them as straightforward as possible.

Changelog for 2.0.0 version with summary of log changes

Added
PROJECT-XXXX MINOR story details goes here.
PROJECT-YYYY PATCH story details goes here.
Changed
Fixed
[1.2.4] - 2020-03-12
Changelog for 1.2.4 version
Added
Changed
PROJECT-ZZZZ MAJOR Angular version change.
Fixed
PROJECT-AAA PATCH Add styles for mat-table.
[1.2.3] - 2019-02-11
Added
Changed
Fixed
PROJECT-123 MINOR Fix core module tests
PROJECT-5454 MAJOR Module cdk version upgrade

如何在Git中定义更新日志的准则?

你可以查看git log命令来获得修订和更改的历史记录

Git日志有更详细的信息

git log --stat --pretty=short --graph

这里有一些经常使用的命令,以获得

如何获得到特定标签为止的所有提交变化?

git log --oneline --decorate v1.0.0

这显示了截至v1.0.0的提交日志

我们可以使用shortlog,它将提交内容按作者分组,并生成修改摘要。

git shortlog v1.0.0

如何获得两个版本之间的更新日志?

下面的命令显示了v1.0.0和v2.0.0两个版本之间的提交变更日志。

git log v1.0.0...v2.0.0

如何在Jenkins中生成变更日志?

Jenkins提供了changelog插件来创建两个修订版之间的注释摘要。

你可以查看更多关于git changelog插件的信息

这个插件可以和

  • 管线插件
  • 构建后的动作

更新日志与发布说明的区别

两者在技术上是一样的,但在描述上有所不同

发行说明是关于一个软件或项目的每个版本的变化的说明文件。它包含了关于变化的补充信息,以及这些变化对终端用户的影响。这对终端客户更有用。

变更日志是关于变更的说明,它包含对已发布产品版本的添加、删除和变更。这对开发者和贡献者更有用。