从目录结构生成变更日志以避免合并冲突
changelogdir的Python项目详细描述
changelogdir
==
从目录结构生成一个changelog以避免合并冲突。
-免费软件:gplv3+
-文档:https://carmenbianca.gitlab.io/changelogdir
-源代码:https://gitlab.com/carmenbianca/changelogdir
-pypi:https://pypi.python.org/pypi/changelogdir
-python:3.4+
-作者:carmen bianca bakker<;carmen@carmenbianca.eu>;
changelogdir是一个简单的实用程序,允许您将目录结构
转换为变更日志文件。每个功能/bugfix/whatever都有自己的文件来列出
中的更改,从而避免合并冲突危机,如“here
<;https://gitlab.com/gitlab org/gitlab ce/issues/17826>;` `.
changelogdir的部分灵感来自于
“保留更改日志”<;http://keep a changelog.com>;`
一个简单的例子
>假设我们的主分支中有一个“changellog.md”的“changellog.md”,它看起来像这样::
1.0.0
-增加了对templeos的支持。
-不推荐使用对windows的支持。
开发人员b在他们的分支中有此功能:
1.0.0
-增加了对templeos的支持。
-增加了对android的支持。
然后将两个分支合并到master会导致合并冲突,这只是
a不必要的麻烦。
changelogdir通过将这些条目放入单独的文件来解决这个问题。因此,
你最终会得到这样一个结果::
令人敬畏的项目
&-changelog
包含:
[changelogdir]
directory=changelog
file\u extension=md
h1=\changelog
h2=\\\{{name}
`android.md``包含:
-增加了对android的支持。
`templaeos.md``包含::
`windows.md``包含:
>-不支持windows.
运行“changelogdir”时,以下是按文件名的字母顺序生成的:
~/awesome project$changelogdir
changelog
1.0.0
-添加了对android的支持。
-添加了对templeos的支持。
-不推荐对windows的支持。
将这三个更改放在一个名为“platform changes.md”的文件中可能更有意义,但这只是为了演示。
——可能有办法解决这个问题(直接调用changelogdir.py
),但它确实很难看。
作为折衷,它在创建和上载
文档时会生成自己的更改日志。参见:doc:`changelog`.
==
从目录结构生成一个changelog以避免合并冲突。
-免费软件:gplv3+
-文档:https://carmenbianca.gitlab.io/changelogdir
-源代码:https://gitlab.com/carmenbianca/changelogdir
-pypi:https://pypi.python.org/pypi/changelogdir
-python:3.4+
-作者:carmen bianca bakker<;carmen@carmenbianca.eu>;
changelogdir是一个简单的实用程序,允许您将目录结构
转换为变更日志文件。每个功能/bugfix/whatever都有自己的文件来列出
中的更改,从而避免合并冲突危机,如“here
<;https://gitlab.com/gitlab org/gitlab ce/issues/17826>;` `.
changelogdir的部分灵感来自于
“保留更改日志”<;http://keep a changelog.com>;`
一个简单的例子
>假设我们的主分支中有一个“changellog.md”的“changellog.md”,它看起来像这样::
1.0.0
-增加了对templeos的支持。
-不推荐使用对windows的支持。
开发人员b在他们的分支中有此功能:
1.0.0
-增加了对templeos的支持。
-增加了对android的支持。
然后将两个分支合并到master会导致合并冲突,这只是
a不必要的麻烦。
changelogdir通过将这些条目放入单独的文件来解决这个问题。因此,
你最终会得到这样一个结果::
令人敬畏的项目
&-changelog
包含:
[changelogdir]
directory=changelog
file\u extension=md
h1=\changelog
h2=\\\{{name}
`android.md``包含:
-增加了对android的支持。
`templaeos.md``包含::
`windows.md``包含:
>-不支持windows.
运行“changelogdir”时,以下是按文件名的字母顺序生成的:
~/awesome project$changelogdir
changelog
1.0.0
-添加了对android的支持。
-添加了对templeos的支持。
-不推荐对windows的支持。
将这三个更改放在一个名为“platform changes.md”的文件中可能更有意义,但这只是为了演示。
——可能有办法解决这个问题(直接调用changelogdir.py
),但它确实很难看。
作为折衷,它在创建和上载
文档时会生成自己的更改日志。参见:doc:`changelog`.