@codedependant/semantic-release-docker 4.5.1 → 5.0.1

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Semantic Release Docker
 
+## [5.0.1](https://github.com/esatterwhite/semantic-release-docker/compare/v5.0.0...v5.0.1) (2024-03-22)
+
+
+### Bug Fixes
+
+* **config**: include the dry-run param from input options [2de549f](https://github.com/esatterwhite/semantic-release-docker/commit/2de549f8dc2dcdc9741c06959ce0d120dd8b5fc5) - Eric Satterwhite
+
+# [5.0.0](https://github.com/esatterwhite/semantic-release-docker/compare/v4.5.1...v5.0.0) (2024-03-22)
+
+
+### Chores
+
+* **compose**: update test registry certs [fa8d771](https://github.com/esatterwhite/semantic-release-docker/commit/fa8d771f8f3381e3b2327a29ab10bb27b1257d1e) - Eric Satterwhite
+
+
+### Features
+
+* **docker**: include support for buildx [ccf9954](https://github.com/esatterwhite/semantic-release-docker/commit/ccf9954fdbad0c25c4ce7b8afcf7730b9652fe76) - Eric Satterwhite, closes: [#44](https://github.com/esatterwhite/semantic-release-docker/issues/44) [#39](https://github.com/esatterwhite/semantic-release-docker/issues/39)
+
+
+### Miscellaneous
+
+* **README.md**: fix typo in README.md [700e2f0](https://github.com/esatterwhite/semantic-release-docker/commit/700e2f0543a1fbd7d59b6ead84870bc8c5cfc3b3) - Eric Satterwhite
+
+
+### **BREAKING CHANGES**
+
+* **docker:** images built with buildx will not be stored locally
+* **docker:** dockerVerifyCmd will only take effect during dry runs (--dry-run)
+
 ## [4.5.1](https://github.com/esatterwhite/semantic-release-docker/compare/v4.5.0...v4.5.1) (2024-02-04)
 
 

package/README.md

@@ -30,7 +30,7 @@ Run `npm i --save-dev @codedependant/semantic-release-docker` to install this se
 
 ### Docker registry authentication
 
-The `docker registry` authentication set via environment variables. It is not required, and if
+Authentication to a `docker registry` is set via environment variables. It is not required, and if
 omitted, it is assumed the docker daemon is already authenticated with the target registry.
 
 ### Environment variables
@@ -48,6 +48,7 @@ omitted, it is assumed the docker daemon is already authenticated with the targe
 | `dockerImage`          | _Optional_. The name of the image to release.                                                                                                                          | [String][]                                    | Parsed from package.json `name` property                      |
 | `dockerRegistry`       | _Optional_. The hostname and port used by the the registry in format `hostname[:port]`. Omit the port if the registry uses the default port                            | [String][]                                    | `null` (dockerhub)                                            |
 | `dockerProject`        | _Optional_. The project or repository name to publish the image to                                                                                                     | [String][]                                    | For scoped packages, the scope will be used, otherwise `null` |
+| `dockerPlatform`       | _Optional_. A list of target platofmrs to build for. If specified, [buildx][] Will be used to generate the final images                                                | [Array][]<[String][]>                   | `null` (default docker build behavior)                        |
 | `dockerFile`           | _Optional_. The path, relative to `$PWD` to a Docker file to build the target image with                                                                               | [String][]                                    | `Dockerfile`                                                  |
 | `dockerContext`        | _Optional_. A path, relative to `$PWD` to use as the build context A                                                                                                   | [String][]                                    | `.`                                                           |
 | `dockerLogin`          | _Optional_. Set to false it by pass docker login if the docker daemon is already authorized                                                                            | [String][]                                    | `true`                                                        |
@@ -59,6 +60,19 @@ omitted, it is assumed the docker daemon is already authenticated with the targe
 | `dockerBuildFlags`     | _Optional_. An object containing additional flags to the `docker build` command. Values can be strings or an array of strings                                          | [Object][]                                    | `{}`                                                          |
 | `dockerBuildCacheFrom` | _Optional_. A list of external cache sources. See [--cache-from][]                                                                                                     | [String][] | [Array][]<[String][]> |                                                               |
 
+
+### BuildX Support
+
+Version 5.X includes initial and experimental support for multi-platform images via the [buildx][] plugin.
+This plugin assumes that the docker daemon and buildx have already been setup correctly.
+Platform specific builder must be setup and selected for this plugin to utilize [buildx][]
+
+> [!WARNING]
+>
+> When using buildx via the dockerPlatform option, images are not kept locally
+> and normal docker commands targeting those images will not work.
+> The `dockerVerifyCmd` behavior will only trigger a build and is unable to execute local command
+
 ### Build Arguments
 
 By default several build arguments will be included when the docker images is being built.
@@ -87,7 +101,7 @@ String template will be passed these
 | `git_sha`      | The commit SHA of the current release                              | [String][]                  |
 | `git_tag`      | The git tag of the current release                                 | [String][]                  |
 | `release_type` | The severity type of the current build (`major`, `minor`, `patch`) | [String][]                  |
-| `relase_notes` | The release notes blob associated with the release                 | [String][]                  |
+| `release_notes`| The release notes blob associated with the release                 | [String][]                  |
 | `next`         | Semver object representing the next release                        | [Object][]                  |
 | `previous`     | Semver object representing the previous release                    | [Object][]                  |
 | `major`        | The major version of the next release                              | [Number][]                  |
@@ -180,6 +194,7 @@ module.exports = {
       dockerFile: 'Dockerfile',
       dockerRegistry: 'quay.io',
       dockerProject: 'codedependant',
+      dockerPlatform: ['linux/amd64', 'linux/arm64']
       dockerBuildFlags: {
         pull: null
       , target: 'release'
@@ -209,7 +224,7 @@ Alternatively, using global options w/ root configuration
     "dockerFile": "Dockerfile",
     "dockerRegistry": "quay.io",
     "dockerArgs": {
-      "GITHUB_TOKEN": true
+      "GITHUB_TOKEN": null
     , "SOME_VALUE": '{{git_sha}}'
     }
   }
@@ -283,3 +298,4 @@ $ openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout server.key -o
 [Object]: https://mdn.io/object
 [Number]: https://mdn.io/number
 [--cache-from]: https://docs.docker.com/engine/reference/commandline/build/#cache-from
+[buildx]: https://docs.docker.com/reference/cli/docker/buildx/build

package/lib/build-config.js

@@ -21,12 +21,14 @@ async function buildConfig(build_id, config, context) {
   , dockerRegistry: registry = null
   , dockerLogin: login = true
   , dockerImage: image
+  , dockerPlatform: platform = null
   , dockerPublish: publish = true
   , dockerContext = '.'
   , dockerVerifyCmd: verifycmd = null
   , dockerNetwork: network = 'default'
   , dockerAutoClean: clean = true
   , dockerBuildQuiet: quiet = true
+  , dryRun: dry_run = false
   } = config
 
   let name = null
@@ -56,6 +58,7 @@ async function buildConfig(build_id, config, context) {
   , publish
   , tags: array.toArray(tags)
   , verifycmd
+  , dry_run
   , args: {
       SRC_DIRECTORY: path.basename(context.cwd)
     , TARGET_PATH: target
@@ -75,5 +78,6 @@ async function buildConfig(build_id, config, context) {
   , network: network
   , quiet: typeCast(quiet) === true
   , clean: typeCast(clean) === true
+  , platform: array.toArray(platform)
   }
 }

package/lib/docker/image.js

@@ -4,9 +4,20 @@ const os = require('os')
 const path = require('path')
 const crypto = require('crypto')
 const execa = require('execa')
+const buildTemplateVars = require('../build-template-vars.js')
 const array = require('../lang/array/index.js')
+const string = require('../lang/string/index.js')
 const SHA_REGEX = /(?:writing image\s)?[^@](?:sha\d{3}):(?<sha>\w+)/i
 
+function render(item, vars) {
+  if (Array.isArray(item)) {
+    return item.map((element) => {
+      return string.template(element)(vars)
+    })
+  }
+  return string.template(item)(vars)
+}
+
 class Image {
   constructor(opts) {
     const {
@@ -19,7 +30,11 @@ class Image {
     , cwd = process.cwd()
     , context = '.'
     , network = 'default'
+    , publish = true
     , quiet = true
+    , dry_run = false
+    , tags = []
+    , platform = []
     } = opts || {}
 
     if (!name || typeof name !== 'string') {
@@ -36,12 +51,53 @@ class Image {
     , dockerfile: dockerfile
     , flags: new Map()
     , name: name
+    , tags: tags
     , network: network
     , project: project
     , registry: registry
+    , dry_run: dry_run
+    , publish: publish
+    , platform: array.toArray(platform)
     }
 
     if (quiet) this.flag('quiet', null)
+
+
+    for (const tag of this.tags) {
+      this.flag('tag', tag)
+    }
+  }
+
+  static from(opts, context) {
+    const vars = buildTemplateVars(opts, context)
+    const tags = opts.tags.map((template) => {
+      return string.template(template)(vars)
+    }).filter(Boolean)
+
+    const image = new(this)({
+      registry: opts.registry
+    , project: opts.project
+    , name: opts.name
+    , dockerfile: opts.dockerfile
+    , build_id: opts.build
+    , cwd: context.cwd
+    , tags: tags
+    , context: opts.context
+    , network: opts.network
+    , quiet: opts.quiet
+    , publish: opts.publish
+    , platform: opts.platform
+    , dry_run: !!opts.dryRun
+    })
+    for (const [key, value] of Object.entries(opts.args)) {
+      image.arg(key, string.template(value)(vars))
+    }
+
+    for (const [key, value] of Object.entries(opts.build_flags)) {
+      image.flag(key, render(value, vars))
+    }
+
+    return image
   }
 
   get id() {
@@ -57,6 +113,10 @@ class Image {
     return parts.join('/')
   }
 
+  get is_buildx() {
+    return !!this.opts.platform?.length
+  }
+
   get name() {
     return `${this.repo}:${this.opts.build_id}`
   }
@@ -102,6 +162,61 @@ class Image {
     return output
   }
 
+  get tags() {
+    const output = []
+    if (this.opts.dry_run) return output
+    for (const tag of this.opts.tags) {
+      output.push(
+        `${this.repo}:${tag}`
+      )
+    }
+
+    return output
+  }
+
+  get build_cmd() {
+    return this.opts.platform.length
+      ? this.buildx_cmd
+      : this.docker_cmd
+  }
+  get docker_cmd() {
+    return [
+      'build'
+    , `--network=${this.network}`
+    , '--tag'
+    , this.name
+    , ...this.flags
+    , '-f'
+    , this.dockerfile
+    , this.context
+    ].filter(Boolean)
+  }
+
+  get buildx_cmd() {
+    if (!this.is_buildx) return
+    this.opts.flags.delete('provenance') // incompatible with load/push
+    this.opts.flags.delete('output') // alias of load/push
+    this.opts.flags.delete('load')
+    this.opts.flags.set('platform', [this.opts.platform.join(',')])
+
+    this.flag('pull', null)
+    if (this.opts.dry_run || !this.opts.publish) {
+      this.opts.flags.delete('push')
+    } else {
+      this.flag('push', null)
+    }
+
+    const cmd = this.docker_cmd
+    cmd.unshift('buildx')
+
+    this.opts.flags.delete('platform')
+    this.opts.flags.delete('push')
+    this.opts.flags.delete('pull')
+    // remove the build id tag
+    cmd.splice(cmd.indexOf(this.name) - 1, 2)
+    return cmd
+  }
+
   arg(key, val = null) {
     if (val === true || val == null) { // eslint-disable-line no-eq-null
       this.flag('build-arg', key)
@@ -130,20 +245,8 @@ class Image {
     return this
   }
 
-  get build_cmd() {
-    return [
-      'build'
-    , `--network=${this.network}`
-    , '--tag'
-    , this.name
-    , ...this.flags
-    , '-f'
-    , this.dockerfile
-    , this.context
-    ].filter(Boolean)
-  }
-
   async run(cmd) {
+    if (this.is_buildx) return
     const stream = execa('docker', [
       'run'
     , '--rm'
@@ -174,6 +277,8 @@ class Image {
         return this.sha
       }
     }
+    this.sha = this.build_id
+    return this.sha
   }
 
   async tag(tag, push = true) {
@@ -187,14 +292,21 @@ class Image {
   }
 
   async push() {
-    await execa('docker', ['push', this.repo])
+    // push is a part of the buildx build operation
+    // At this point the tags have already been pushed.
+    // re-pushing manually is considered destructive
+    if (this.is_buildx) return
+    if (!this.opts.publish) return
+
+    for (const tag of this.opts.tags) {
+      await this.tag(tag)
+    }
   }
 
   async clean() {
-    const images = execa('docker', ['images', this.repo, '-q'])
-    const rm = execa('xargs', ['docker', 'rmi', '-f'])
-    images.stdout.pipe(rm.stdin)
-    return rm
+    const {stdout: images} = await execa('docker', ['images', this.repo, '-q'])
+    if (!images) return
+    await execa('docker', ['rmi', '-f', ...images.split(os.EOL)])
   }
 }
 

package/lib/post-publish.js

@@ -5,17 +5,8 @@ const docker = require('./docker/index.js')
 module.exports = postPublish
 
 async function postPublish(opts, context) {
-  const {cwd, logger} = context
-  const image = new docker.Image({
-    registry: opts.registry
-  , project: opts.project
-  , name: opts.name
-  , dockerfile: opts.dockerfile
-  , build_id: opts.build
-  , cwd: cwd
-  , context: opts.context
-  })
-
+  const {logger} = context
+  const image = docker.Image.from(opts, context)
   if (!opts.clean) return
 
   logger.info(`removing images for ${image.repo}`)

package/lib/prepare.js

@@ -1,47 +1,15 @@
 'use strict'
 
-const path = require('path')
 const docker = require('./docker/index.js')
-const buildTemplateVars = require('./build-template-vars.js')
-const string = require('./lang/string/index.js')
 
 module.exports = dockerPrepare
 
 async function dockerPrepare(opts, context) {
-  const {cwd} = context
-  const image = new docker.Image({
-    registry: opts.registry
-  , project: opts.project
-  , name: opts.name
-  , dockerfile: opts.dockerfile
-  , build_id: opts.build
-  , cwd: cwd
-  , context: opts.context
-  , network: opts.network
-  , quiet: opts.quiet
-  })
-
-  const vars = buildTemplateVars(opts, context)
-
-  function render(item, vars) {
-    if (Array.isArray(item)) {
-      return item.map((element) => {
-        return string.template(element)(vars)
-      })
-    }
-    return string.template(item)(vars)
-  }
-
-  for (const [key, value] of Object.entries(opts.args)) {
-    image.arg(key, string.template(value)(vars))
-  }
-
-  for (const [key, value] of Object.entries(opts.build_flags)) {
-    image.flag(key, render(value, vars))
-  }
-
+  const image = docker.Image.from(opts, context)
   context.logger.info('building image', image.name)
-  context.logger.debug('build command: docker %s', image.build_cmd.join(' '))
-  await image.build(path.join(cwd, opts.context))
+  context.logger.info('build command: docker %s', image.build_cmd.join(' '))
+
+  await image.build()
   return image
 }
+

package/lib/publish.js

@@ -1,32 +1,10 @@
 'use strict'
 
-const buildTemplateVars = require('./build-template-vars.js')
 const docker = require('./docker/index.js')
-const string = require('./lang/string/index.js')
 
 module.exports = publish
 
 async function publish(opts, context) {
-  const {cwd, logger} = context
-  const image = new docker.Image({
-    registry: opts.registry
-  , project: opts.project
-  , name: opts.name
-  , dockerfile: opts.dockerfile
-  , build_id: opts.build
-  , cwd: cwd
-  , context: opts.context
-  , quiet: opts.quiet
-  })
-
-  const vars = buildTemplateVars(opts, context)
-  const tags = opts.tags.map((template) => {
-    return string.template(template)(vars)
-  }).filter(Boolean)
-
-  logger.info('tagging docker image', image.id)
-  for (const tag of tags) {
-    logger.info(`pushing image: ${image.repo} tag: ${tag}`)
-    await image.tag(tag, opts.publish)
-  }
+  const image = docker.Image.from(opts, context)
+  await image.push()
 }

package/lib/verify.js

@@ -10,7 +10,7 @@ const docker = require('./docker/index.js')
 module.exports = verify
 
 async function verify(opts, context) {
-  const {env, cwd} = context
+  const {env} = context
   const PASSWORD = env.DOCKER_REGISTRY_PASSWORD || env.GITHUB_TOKEN
   const USERNAME = env.DOCKER_REGISTRY_USER
 
@@ -24,16 +24,7 @@ async function verify(opts, context) {
     throw error
   }
 
-  const image = new docker.Image({
-    registry: opts.registry
-  , project: opts.project
-  , name: opts.name
-  , dockerfile: opts.dockerfile
-  , build_id: opts.build
-  , cwd: cwd
-  , context: opts.context
-  , network: opts.network
-  })
+  const image = docker.Image.from(opts, context)
 
   debug('docker options', opts)
 
@@ -57,11 +48,11 @@ async function verify(opts, context) {
     await doLogin({...opts, USERNAME, PASSWORD}, context)
   }
 
-  if (!opts.verifycmd) return true
+  if (!opts.verifycmd && !opts.dry_run) return true
 
   const img = await prepare(opts, context)
   const output = await img.run(opts.verifycmd)
-  if (opts.dryRun) await img.clean()
+  await img.clean()
   return output
 }
 
@@ -78,7 +69,7 @@ async function doLogin(opts, context) {
 
     if (set !== 2) {
       const error = new SemanticError(
-        'Docker authentication failed'
+        `Docker authentication failed ${USERNAME} ${PASSWORD}`
       , 'EAUTH'
       , 'Both ENV vars DOCKER_REGISTRY_USER and DOCKER_REGISTRY_PASSWORD must be set'
       )
@@ -100,7 +91,7 @@ async function doLogin(opts, context) {
     } catch (err) {
       logger.fatal(err)
       const error = new SemanticError(
-        'Docker authentication failed'
+        `Docker authentication failed ${USERNAME} ${PASSWORD}`
       , 'EAUTH'
       , `Authentication to ${opts.registry || 'dockerhub'} failed`
       )

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codedependant/semantic-release-docker",
   "private": false,
-  "version": "4.5.1",
+  "version": "5.0.1",
   "description": "docker package",
   "main": "index.js",
   "files": [
@@ -21,7 +21,8 @@
     "lint:fix": "npm run lint -- --fix",
     "local": "env $(cat env/local.env)",
     "pretap": "npm run lint",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "release:dry": "semantic-release --no-ci --dry-run --branches=${BRANCH_NAME:-main}"
   },
   "keywords": [
     "semantic-release"