matyan 0.4.7

先决条件

• Python 3.6, 3.7和3.8

文档

文档可在Read the Docs上找到。

安装

PyPI上的最新稳定版本

pip install matyan

用法

generate-changelog

generate-changelog --no-other

generate-changelog 0.0.1..0.0.3

generate-changelog master..acceptance

generate-changelog --show-releases

generate-changelog 0.0.1..0.0.3 --show-releases

generate-changelog master..dev --show-releases

generate-changelog --latest-release --show-releases

generate-changelog --headings-only --show-releases

generate-changelog master..acceptance --show-releases --unreleased-only

generate-changelog --show-releases --renderer=markdown

generate-changelog --show-releases --renderer=rest

generate-changelog --show-releases --renderer=historical-markdown

[Settings]
fetchDataFrom=Jira

generate-changelog --show-releases --fetch-title --fetch-description

pip install matyan[jira]

pip install atlassian-python-api

配置

为了自定义名称和文本，在运行generate-changelog命令的项目目录中添加一个.matyan.ini。

示例配置

[BranchTypes]
feature: Feature
bugfix: Bugfix
hotfix: Hotfix
deprecation: Deprecation

[OtherBranchType]
other: Other

[Unreleased]
unreleased: Unreleased

[IgnoreCommits]
exact: more
       clean up
       code comments
       more on docs
       repo
       working
       more on
       wip
       commit
prefix: more on
        continue on

请注意，将.matyan.ini放置在主目录中将使该配置对所有项目全局有效。但是，由于本地.matyan.ini文件仅扩展全局配置，因此这可能很有用。例如，您可以使用全局配置来存储Jira凭据。

[Jira]
url:https://barseghyanartur.atlassian.net/
username:user@domain.com
token:abcd1234

然而，请注意，将完全复制部分。

技巧和窍门

generate-changelog --show-releases 2>&1 | tee changelog.md

matyan-make-config

测试

只需输入

./runtests.py

或使用tox

tox

或使用tox检查特定环境

tox -e py38

调试

有时检查日志可能会有所帮助。Matyan日志存储在您运行generate-changelog（或任何其他Matyan）命令的目录中。

以下方式更新您的.matyan.ini配置

[Settings]
debug=true

tail -f /path/to/your/project/matyan.log

如果您想修改当前的日志记录，请使用MATYAN_LOGGING_CONFIG环境变量。

默认配置

DEFAULT_LOGGING_CONFIG = {
    'version': 1,
    'disable_existing_loggers': False,
    'root': {
        'level': 'WARNING',
        'handlers': ['file'],
    },
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} '
                      '{message}',
            'style': '{',
        },
        'simple': {
            'format': '{levelname} {message}',
            'style': '{',
        },
    },
    'handlers': {
        'console': {
            'level': 'WARNING',
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'file': {
            'level': 'WARNING',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(os.getcwd(), "matyan.log"),
            'maxBytes': 1048576,
            'backupCount': 99,
            'formatter': 'verbose',
        },
    },
    'loggers': {
        'matyan': {
            'handlers': ['file'],
            'propagate': True,
        },
    },
}

编写文档

请保持以下层次结构。

=====
title
=====

header
======

sub-header
----------

sub-sub-header
~~~~~~~~~~~~~~

sub-sub-sub-header
^^^^^^^^^^^^^^^^^^

sub-sub-sub-sub-header
++++++++++++++++++++++

sub-sub-sub-sub-sub-header
**************************

许可证

GPL-2.0-only OR LGPL-2.1-or-later

支持

有关任何问题，请联系作者部分中给出的电子邮件。

作者

Artur Barseghyan <artur.barseghyan@gmail.com>