gitlab-job-guard 0.0.4.3

$gitlab_api_token是个人访问 令牌< a > 至少有api范围。

before_script:-PRIVATE_TOKEN="$GITLAB_API_TOKEN" gitlab-job-guard

尽管通常，大多数管道只需要保护共享的关键工作 公共状态/数据（即，配置/部署作业、工件构建/发布 工作等）。

deploy-production:stage:deployscript:-PRIVATE_TOKEN="$GITLAB_API_TOKEN" gitlab-job-guard-my-unguarded-deployment-task --to=production

例如，保护一些关键的东西，比如为一个标签运行的terraform作业

provision-infrastructure:stage:provisionscript:-export PRIVATE_TOKEN="$GITLAB_API_TOKEN"-gitlab-job-guard --guard-ref-regex='^v[0-9\.]+'# Regex matches tags-terraform plan  ...-terraform apply ...only:-tags

其他用法

--guard ref regex接受正则表达式来检测其他 其引用名称（分支、标记）为（部分）匹配的管道。这就允许 在复杂的用例中保护作业。

为分支/标记名上的模式匹配上的冲突保留作业。

gitlab-job-guard -c=^master$                # Match branch names matching 'master' exactly

gitlab-job-guard -c=^(master|dev(elop)?)$   # Match any of the mainline branches

gitlab-job-guard -c=^(feature|release|hotfix)/  # Match any gitflow transient branch prefixes

gitlab-job-guard -c=^[0-9]\-# Match branch names beginning with a number# and dash ignoring all other text.# e.g. a gitlab branch made from an issue

gitlab-job-guard -c=^v?[\d.]+$              # Match (semver) tags like v1.0.9, 2.0

gitlab-job-guard -c=^environment/           # Match any environment deployments?

gitlab-job-guard -c=^environment/dc1.+      # Match environment deployments to DC1?

gitlab-job-guard -c="$CI_BUILD_REF_NAME"# Match current branch name (partially).# i.e. 'master' matches 'feature/master-document'

gitlab-job-guard -c="^$CI_BUILD_REF_NAME$"# Match current branch name (exactly).# i.e. 'master' does not match 'master-deployment'

gitlab-job-guard -c='.+' -s='running|pending'# Match any pipeline in running or pending state

在ref名称的一部分（例如，在分支前缀上）上为冲突保留作业 例如feature/或hotfix/或release/等a lagitflow）。

# Assuming current pipeline is for the 'feature/foo' branch and that# CI_BUILD_REF_NAME=feature/foo# Extract the branch prefixCI_BUILD_REF_PREFIX=$(echo"$CI_BUILD_REF_NAME"| sed -r 's@(.+/)(.+)@\1@')# CI_BUILD_REF_PREFIX now contains 'feature/'# This will now block if there are any other pipelines running or pending# for feature/ branches.
gitlab-job-guard -c="^$CI_BUILD_REF_PREFIX" -s='running|pending'

其他参数

通常gitlab job guard读取以下环境变量 组成它的论点。注意：环境变量优先 通过cli传递的参数，因此只有用户指定的 需要设置参数/环境变量。将这些设置为受保护的环境 变量避免 泄露敏感信息，每次通话都需要复制这些信息。

envvar              |  argument             | source
-------------------   ---------------------   ----------------
GUARD_REF_REGEX     | --guard-ref-regex     | user specified
GUARD_STATUS_REGEX  | --guard-status-regex  | user specified
PRIVATE_TOKEN       | --private-token       | user specified
GUARD_TIMEOUT       | --guard-timeout       | user specified
CI_PROJECT_ID       | --ci-project-id       | runner environment
CI_BUILD_REF_NAME   | --ci-build-ref-name   | runner environment
CI_API_V4_URL       | --ci-api-v4-url       | runner environment
CI_PIPELINE_ID      | --ci-pipeline-id      | runner environment

有关完整参数集和当前/默认值，请参见gitlab job guard-h。

行为

gitlab作业保护程序将退出并重试，直到安全继续或 已达到超时。退出代码0表示没有其他管道冲突 这项工作可以继续下去。达到超时时（1小时by def奥特 与gitlab作业的默认超时对齐），它将返回错误以失败 这项工作。可以通过-w/--guard timeout