在gitlab ci中工作的工具
gitlab-ci-tools的Python项目详细描述
从gitlab ci中获取有用信息(例如,上次成功构建的git散列)的脚本
概述
通常在使用gitlab ci时,您需要的信息不是 可从ci提供的environment variables获得 跑步者。此包包含用于获取 来自gitlab api的信息
许可证
gitlab-ci-tools根据简化(2子句)bsd许可证获得许可。 有关详细信息,请参见LICENSE文件。
安装
脚本是用python 3编写的,因此需要安装 在执行以下操作之前:
pip3 install gitlab-ci-tools
您可以在本地计算机上安装软件包进行测试 脚本(有关详细信息,请参见使用部分),但是通常 您需要将此软件包安装到gitlab ci环境中。
最简单的方法是在顶部添加以下内容 你的.gitlab-ci.yml:
before_script: - pip3 install gitlab-ci-tools
用法
安装gitlab-ci-tools会安装一组脚本,您可以 从命令行运行。有关已安装的 工具。
为了让脚本能够访问gitlab api,您必须 提供包含 具有api作用域的个人访问令牌(签出these instructions到 了解如何生成一个)。
工具列表
last-good-build
打印当前分支上次成功生成的git哈希。 一个有用的例子是生成两个乳胶之间差异的pdf 文档:
before_script: pip install gitlab-ci-tools LAST_GOOD_BUILD=$(last-good-build || echo '') report diff: script: - git show $LAST_GOOD_BUILD:important_doc.tex > old_doc.tex - latexdiff old_doc.tex important_doc.tex > diff_doc.tex - latexmk -pdf diff_doc.tex artifacts: paths: - diff_doc.pdf
贡献
我很乐意在这里添加更多的工具,而不仅仅是那些我觉得有用的工具。 如果脚本遵循与 现有的(即提供一个^ {tt7} $函数),并公开一条命令行 可以通过命令行选项或环境变量驱动, 但如果需要的话,我很乐意指导任何人通过这个过程。
一旦有了不止一个脚本,我们就可以开始思考 分离出共同的功能,这样我们就可以减少样板。