使用YAML管理Jenkins作业

导航

验证详情

这些详情已由PyPI验证
维护者
Avatar for cboylan from gravatar.com cboylan Avatar for corvus from gravatar.com corvus Avatar for openstackci from gravatar.com openstackci Avatar for zxiiro from gravatar.com zxiiro

未验证详情

这些详情未由PyPI验证
项目链接
元数据
分类

项目描述

Jenkins Job Builder 可以使用 YAML 或 JSON 格式描述 Jenkins 任务的简单描述，并使用这些描述来配置 Jenkins。您可以将任务描述保存在可读的文本格式中，以便在版本控制系统中进行更改和审计，从而简化操作。它还具有灵活的模板系统，因此创建具有相似配置的多个任务变得容易。

安装

$ pip install --user jenkins-job-builder

在线文档

开发者

错误报告

存储库

克隆

git clone https://opendev.org/jjb/jenkins-job-builder.git

为了在您的提交上运行一些基本的测试，请从 https://pre-commit.git-scm.cn/#intro 安装 pre-commit。

建议在开发中使用虚拟环境。例如，可以从顶层目录安装 Jenkins Job Builder

$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -r test-requirements.txt -e .

补丁通过 Gerrit 在以下网址提交

请勿提交 GitHub pull 请求，它们将被自动关闭。

邮件列表

IRC

  • #openstack-jjb 在 OFTC

有关如何贡献的更多详细信息，请访问我们的维基百科

编写补丁

我们要求所有代码提交都通过 pep8 和 pyflakes 清理。最简单的方法是在将代码提交到 Gerrit 进行审查之前运行 tox。它将以与将要运行在提议的补丁集上的自动化测试套件相同的方式运行 pep8 和 pyflakes。

创建新的 YAML 组件时，请注意以下风格约定

  • 所有 YAML 标识符（包括组件名称和参数）应使用小写，并且多词标识符应使用连字符。例如，“build-trigger”。

  • 实现组件的 Python 函数应与 YAML 关键字具有相同的名称，但应使用下划线而不是连字符。例如，“build_trigger”。

这种一致性将帮助用户在编写 YAML 时避免简单的错误，同时也帮助开发人员在将 YAML 组件与 Python 实现匹配时避免错误。

单元测试

已包含单元测试，并在 tests 文件夹中。我们的文档中包含了许多单元测试示例，以确保示例与现有行为保持一致。要运行单元测试，请执行以下命令

tox -e py38

可以使用 pytest-parallel 插件并行运行单元测试

tox -e py38 -- --workers=auto

  • 注意：查看 tox.ini 以在 Python 的其他版本上运行测试，生成文档，并查看有关在代理后运行测试以验证文档外部 URL 的任何特殊说明。

无需 setup.py 安装

对于 YAML 支持，您需要安装 libyaml。

Mac OS X

$ brew install libyaml

然后使用 pip 安装所需的 Python 包

$ sudo pip install PyYAML python-jenkins

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面