Gitlab通知程序配置工具。
foliantcontrib.notifier的Python项目详细描述
Gitlab通知程序配置工具
cli扩展,用于设置项目的GitLab notifier配置。
安装
$ pip install foliantcontrib.notifier
用法
Note that to use this command you will have to specify valid config first!
为此回购申请通知:
$ foliant notifier setup
禁用此回购中的通知:
$ foliant notifier disable
配置
在运行通知程序命令之前,必须提供有效的配置。在foliant.yml
中的notifier
部分设置它。
在基本形式notifier
中,应按照GitLab notifier Config section中的说明填写内容,例如:
notifier:mail_config:host:mail.example.comport:587user:notifier@example.compassword:currently_stored_as_plain_textprojects:test-project:-match:-test1.txt-test/file1.txtmailing_list:-john@gmail.com-sam@gmail.com-mailing_list:-sam@gmail.commatch:-test1.txt-test/*ignore:-file3.txt
mail_config
-将发送通知的邮件服务器帐户的凭据。
projects
部分,描述正在跟踪的gitlab项目。
test-project
-项目的名称。在浏览器地址栏中可以看到:gitlab.com/username/test project。在我们的例子中,这应该是我们在gitlab的叶子项目的名称。
接下来是一个带有跟踪设置的列表。每组可以有以下部分:
mailing_list
-将接收通知的电子邮件地址列表。
match
-类glob模式的列表。如果存储库中与这些模式匹配的文件发生更改,脚本将向该组中设置的邮件列表发送通知。
ignore
-要忽略的全局文件模式列表。
其他选项
预处理器还具有一些附加选项,允许调整其行为:
notifier:repo_url:'https://gitlab.com/ddddsa/gitlab_notifier.git'config:'notifier_config.yml'stage:'notify'job:'notifier'image:'python:latest'branches:-'develop'python:3
repo_url
:要使用的Gitlab通知程序脚本存储库的URL。
config
:为脚本生成的配置文件的名称。
stage
:要在.gitlab-ci.yml
中的作业中使用的阶段的名称。
job
:通知程序在.gitlab-ci.yml
中的作业名称。
image
:用于运行脚本的Docker映像的名称。默认值是python:latest
。设置为空字符串''
以使用.gitlab-ci.yml
全局图像。
branches
:启用通知的分支名称列表。
python
:将运行脚本的docker映像中使用的python版本。