Gitlab CI使用徽章进行每项工作

问题描述 投票：11回答：4

假设我为一个项目配置了多个作业，如下所示：

build_win32:
  script: ...

build_ios:
  script: ...

unit_tests:
  script: ...

server_tests:
  script: ...

client_tests:
  script: ...

我想要实现的是在README.md下为每个作业配置标记，以便我可以立即反馈具体哪个部分出错。

有一个Gitlab Documentation设置徽章，但这有一个限制，它显示如何配置build和coverage status徽章。

我想知道Gitlab CI中是否有这样的内置功能。我也可以使用第三方插件。任何帮助将不胜感激。

gitlab-ci badge
4个回答
12
投票

您可以通过在管道步骤中创建标记，将标记文件注册为管道工件并将它们发布到GitLab页面来实现所需。从那里你可以参考你的README.md徽章

How to do what you asked

1.生成徽章

在每个CI步骤中，您需要生成徽章文件，并将它们存储在public/<badge-file>.svg下

您可以使用http://shields.io生成徽章文件。我已经编写了自己的Python徽章生成器，可以在这里找到：https://github.com/jongracecox/anybadge

2.将徽章注册为管道工件

将每个生成的徽章文件注册为CI作业中的工件，方法是将其包含在.gitlab-ci.yml中的每个作业中：

build_win32:
  script: ...
    - <generate public/build_win32.svg>
  artifacts:
    paths:
      - public/build_win32.svg

build_ios:
  script: ...
    - <generate public/build_ios.svg>
  artifacts:
    paths:
      - public/build_ios.svg

unit_tests:
  script: ...
    - <generate public/unit_tests.svg>
  artifacts:
    paths:
      - public/unit_tests.svg

server_tests:
  script: ...
    - <generate public/server_tests.svg>
  artifacts:
    paths:
      - public/server_tests.svg

client_tests:
  script: ...
    - <generate public/client_tests.svg>
  artifacts:
    paths:
      - public/client_tests.svg

3.将徽章发布到GitLab Pages

包括一个新的pages发布步骤，其中deploys everything in the public directory to GitLab pages：

pages:
  stage: deploy
  artifacts:
    paths:
    - public
  only:
  - master

您不需要修改上述内容。运行此作业后，public中的所有文件都将通过GitLab页面Web服务器提供。这通常是http://NAMESPACE.GITLABPAGESSERVER/project

在这里阅读更多关于GitLab页面的信息：https://docs.gitlab.com/ce/user/project/pages/index.html

4.在README.md中包含徽章

当主管道为项目运行时，徽章文件将发布到GitLab页面，然后可以从项目README.md中引用。

Why this might not make sense

我理解为什么你会问这个问题，但我想解释你为什么不想这样做。

GitLab管道在每次推送到项目时运行 - 在每个分支上。通常，您只想从master分支（或发布）分支为您的README文件生成徽章，因此您需要restrict the pages step to only run on master@group/project。

还要考虑通常将管道配置为在作业发生错误时停止。这意味着如果主管道作业失败，则不会生成该管道的标记，因此无法确定哪个作业失败。

获得即时反馈的最佳位置是在管道视图中，您可以通过管道链接将管道成功徽章添加到自述文件中，通常类似于https://gitlabserver/namespace/project/badges/branch/build.svg

如果您仍想使用您所描述的方法，那么我的建议是将每个管道阶段设置为allow failure。这将允许整个管道运行，尽管任何作业都出现故障，并且徽章仍应生成，并发布到Pages。

6
投票

您可以按照JGC的步骤进行操作，但不是在Gitlab页面的公共目录上部署徽章，而是可以直接链接到最新的构建工件。

例如，以下URL链接到使用anybadge创建并作为工件上载的pylint标记。

https://gitlabserver/namespace/project/-/jobs/artifacts/master/raw/public/pylint.svg?job=test

3
投票

我为实时的每个作业徽章开发了一个解决方法。它可以很容易地修改成其他任何东西。

示例回购：ci-test/badges。还有一个完整的演练，所以我不会在这里复制粘贴它。

核心思想是（假设您现在正在运行的CI工作中）：

  • 从Web获取徽章到文件。
  • 将徽章文件上传到可以链接的实时存储（例如Dropbox）。

Dropbox支持通过HTTP请求调用其API（请参阅this）。因此，所有上述内容都可以使用例如完成。 curl或Python请求 - 基本工具。您只需将Dropbox访问令牌作为secret variable传递，并以相同的名称保存文件以覆盖旧徽章。

然后，您可以直接将Dropbox徽章链接到您需要的任何位置。有一些技巧，所以一定要检查我的示例回购，如果你想使用它。对我而言，它运作良好，似乎很快。

这种方法的优点是你不必乱用GitLab页面。您可以将它放在Dropbox上，而不是在Pages上发布。这是HTTP请求调用的简单文件传输。没有更多。

3
投票

我更喜欢使用临时分支来存储不同ci作业之间的徽章。

您可以在此处找到详细的项目示例，其中显示了如何使用GitLab的临时分支来为每个作业使用徽章：https://gitlab.version.fz-juelich.de/vis/jusense-cicd

它的文档在这里：https://gitlab.version.fz-juelich.de/vis/jusense-cicd/wikis/Continuous-Integration-and-Delivery

但是，无论您喜欢什么策略，自定义徽章到目前为止都没有在GitLab中得到适当支持。请查看此问题以获取更多详细信息：已在GitLab上创建了一个问题：https://gitlab.com/gitlab-org/gitlab-ce/issues/50603

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.