@ codedependant/ semantic- release- docker (英语)

A 类 语义释放 对嵌入器图像使用语义化版本的插件 .

支持的步骤

校验条件

验证通过用户名和密码进行认证的环境变量. 它使用一个通过配置或环境变量(首选)提供的注册服务器,或者默认在不给出的情况下使用嵌入器中枢. 它还通过登录到特定登记册核实证书正确无误.

准备

使用指定的嵌入器文件和上下文构建图像。 此图像将在后期步骤中用于创建标记

发布

将带有指定标记的图像推到注册处. 标记支持简单的导出 手柄栏. 括号中的数值 {{}} 将替换为发布上下文信息

安装

运行 npm i --save-dev @codedependant/semantic-release-docker 安装此语义释放插件.

配置

Docker 注册认证

认证到 a docker registry 通过环境变量设置。 不需要,如果 中,它被假定在目标注册处已经认证了 docker 守护进程 .

环境变量

选项

构建X 支持

5.X版本包括通过该版本对多平台图像的初步和实验支持 构建x 插件 . 此插件假设已正确设置了 Docker 守护进程和 builtx . 必须为此插件设置和选择平台特定构建器以使用 构建x

[尖叫声]

在通过多克Platform 选项使用 builtx 时, 图像不保存在本地 而针对这些图像的普通道克命令不会成功. 这个 dockerVerifyCmd 行为只触发构建, 无法执行本地命令

证明书

当推进注册时, 构建x 附上a 来源证明 (单位:千美元)mode=min改为: 默认图像索引。 这额外 unknown/unknown 显示在指数上,有些 登记册和集装箱运行时间完全拒绝----特别是AWS Lambda集装箱图像.

证明(和SBOM)的证明可以通过 dockerBuildFlags数字 :

{
  dockerBuildFlags: {
    provenance: false
  , sbom: false
  }
}

或者设置 BUILDX_NO_DEFAULT_ATTESTATIONS=true 在环境中,释放会进入.

构建参数

默认情况下,在建起嵌入器图像时会包含几个构建参数 . 构建参数可以和道克标记一样被模板. 如果一个值 构建参数是明确的 true中,该值将被省略,该值来自 将取而代之的是相应的环境变量。 这在试图纳入时可能有用 机密和其他敏感信息

模板变量

字符串模板将会通过这些

模板帮助

以下手柄栏模板帮助器已预先安装

{{#if (endswith myvar 'ing')}}{{ othervar }}{{/if}}

{{#if (eq var_one var_two)}}{{ var_three }}{{/if}}

{{#if (gt var_one var_two)}}{{ var_three }}{{/if}}

{{#if (gte var_one var_two)}}{{ var_three }}{{/if}}

{{#if (includes some_array 'one')}}{{ var_one }}{{/if}}

{{ lower my_var }}

{{#if (lt var_one var_two)}}{{ var_three }}{{/if}}

{{#if (lte var_one var_two)}}{{ var_three }}{{/if}}

{{#if (neq var_one var_two)}}{{ var_three }}{{/if}}

{{#with (pick var_one, var_two) as | value |}}{{ value }}{{/with}}

{{#each (split csv_value)}}{{ this }}{{/each}}

{{#if (starts myvar 'foo')}}{{ othervar }}{{/if}}

{{upper my_var}}

构建旗帜

使用 dockerBuildFlags 选项允许您向构建命令传递任意的旗帜. 如果标准选项不够, dockerBuildFlags 是一个完美的工作 直到可以添加头等舱支持。 这是考虑和先进的功能,你应该 在使用之前,你知道你打算做什么。 没有验证,也没有配置 需要的多克守护进程预计将在手前完成 .

在其中找到密钥 dockerBuildFlags 以下列方式作为命令行旗正常化:

• 如果密钥不是以一个开头 - 准备就绪
• 所有意外情况 _ 将重写为 -
• 单字母密钥被认为是简指如. p 变成 -p
• 多字母键被认为是长形式,例如. foo_bar 变成 --foo-bar
• 如果值是数组,则每次发生时会重现旗子
• A 类 null 值可能用于省略值并仅注入旗帜本身

示例

{
  plugins: [
    ['@codedependant/semantic-release-docker', {
      dockerImage: 'my-image',
      dockerRegistry: 'quay.io',
      dockerProject: 'codedependant',
      dockerCacheFrom: 'myname/myapp'
      dockerBuildFlags: {
        pull: null
      , target: 'release'
      },
      dockerArgs: {
        GITHUB_TOKEN: null
      }
    }]
  ]
}

此配置将生成以下构建命令

> docker build --network=default --quiet --tag quay.io/codedependant/my-image:abc123 --cache-from myname/myapp --build-arg GITHUB_TOKEN --pull --target release -f path/to/repo/Dockerfile /path/to/repo

使用量

完整配置数字 :

// release.config.js

module.exports = {
  branches: ['main']
  plugins: [
    ['@codedependant/semantic-release-docker', {
      dockerTags: ['latest', '{{version}}', '{{major}}-latest', '{{major}}.{{minor}}'],
      dockerImage: 'my-image',
      dockerFile: 'Dockerfile',
      dockerRegistry: 'quay.io',
      dockerProject: 'codedependant',
      dockerPlatform: ['linux/amd64', 'linux/arm64']
      dockerBuildFlags: {
        pull: null
      , target: 'release'
      },
      dockerArgs: {
        API_TOKEN: null
      , RELEASE_DATE: new Date().toISOString()
      , RELEASE_VERSION: '{{next.version}}'
      }
    }]
  ]
}

结果 quay.io/codedependant/my-image 带有标签 latest, (中文(简体) ), 1.0.0, (中文(简体) ), 1-latest 编辑 1.0 由 semantic-release。 。 。 .

或者,使用全局选项 w/ 根配置

// package.json
{
  "name": "@codedependant/test-project"
  "version": "1.0.0"
  "release": {
    "extends": "@internal/release-config-docker",
    "dockerTags": ["latest", "{{version}}", "{{major}}-latest", "{{major}}.{{minor}}"],
    "dockerImage": "my-image",
    "dockerFile": "Dockerfile",
    "dockerRegistry": "quay.io",
    "dockerArgs": {
      "GITHUB_TOKEN": null
    , "SOME_VALUE": '{{git_sha}}'
    }
  }
}

这将产生以下结果: 1.2.0 构建

$ docker build -t quay.io/codedependant/my-image --build-arg GITHUB_TOKEN --build-arg SOME_VALUE=6eada70 -f Dockerfile .
$ docker tag <SHA1> latest
$ docker tag <SHA1> 1.2.0
$ docker tag <SHA1> 1.2
$ docker tag <SHA1> 1-latest
$ docker push quay.io/codedependant/my-image

最小配置数字 :

{
  "release": {
    "plugins": [
      "@codedependant/semantic-release-docker"
    ]
  }
}

• 一个软件包名称 @codedependant/test-project 居克项目名称的结果codedependant 图像名称 test-project
• 一个软件包名称 test-project 生成一个嵌入器图像名称 test-project

用于 1. 0.0 释放的默认嵌入器图像标记为 1.0.0, (中文(简体) ), 1-latest, (中文(简体) ), latest

示例预释配置数字 :

{
  "release": {
    "dockerTags": [
      "{{#if prerelease.[0]}}{{prerelease.[0]}}{{else}}latest{{/if}}",
      "{{major}}-{{#if prerelease.[0]}}{{prerelease.[0]}}{{else}}latest{{/if}}",
      "{{major}}.{{minor}}-{{#if prerelease.[0]}}{{prerelease.[0]}}{{else}}latest{{/if}}",
      "{{version}}"
    ]
  }
}

版本的嵌入标记 1.2.3 将会是 1.2.3, (中文(简体) ), 1.2-latest, (中文(简体) ), 1-latest 财务报告和审定财务报表 latest 版本的嵌入标记 2.3.4-beta.6 将会是 2.3.4-beta.6, (中文(简体) ), 2.3-beta, (中文(简体) ), 2-beta 财务报告和审定财务报表 beta

GitHub 动作

通过曝光多个输出和环境变量,该插件对 github 动作有一些基本支持 在出版阶段

[尖叫声]

当使用builtx图像 shas时,每个平台都不同,因此直接使用 shas 不支持,并可能导致出乎意料的结果.

产出

环境变量

发展

Docker 书记官处

为了能够将认证证书推入本地登记册,需要sl证书. 此项目使用自签名的证书 。 重新生成证书运行如下:

$ openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout server.key -out server.crt

页:1:当要求国防军时,必须是 registry:5000 页:1: 当地登记册的全权证书为: 用户 : iamweasel, (中文(简体) ), 过: secretsquirrel