@codedependant/semantic-release-docker 3.1.1 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # Semantic Release Docker
 
+# [4.1.0](https://github.com/esatterwhite/semantic-release-docker/compare/v4.0.0...v4.1.0) (2022-04-10)
+
+
+### Chores
+
+* **deps**: semantic-release/error@3.0.0 [d55ff11](https://github.com/esatterwhite/semantic-release-docker/commit/d55ff1108a0130ce10932e409683fb741fb315d3) - Eric Satterwhite
+* **deps**: tap@16.0.0 [94d3340](https://github.com/esatterwhite/semantic-release-docker/commit/94d3340dba42ed702b71325ea5afc2f627df1fcc) - Eric Satterwhite
+
+
+### Features
+
+* **docker**: allow command to be run via docker in verify step [4646bd6](https://github.com/esatterwhite/semantic-release-docker/commit/4646bd681cb4d7ee4a48a9187fbe7dfe88686b78) - Eric Satterwhite, closes: [#20](https://github.com/esatterwhite/semantic-release-docker/issues/20)
+
+
+### Miscellaneous
+
+* add prerelease example [90158fd](https://github.com/esatterwhite/semantic-release-docker/commit/90158fdaa65b35a861ce40ca2c3a660f28446f72) - Eric Satterwhite
+* Update Readme [74f9910](https://github.com/esatterwhite/semantic-release-docker/commit/74f99107723223a67009c96a762b200f8d25621d) - GitHub
+
+# [4.0.0](https://github.com/esatterwhite/semantic-release-docker/compare/v3.1.2...v4.0.0) (2021-12-31)
+
+
+### Chores
+
+* **deps**: @codedependant/release-config-npm@1.0.4 [fdb0985](https://github.com/esatterwhite/semantic-release-docker/commit/fdb0985d346b1f74d61cf4d0ef238743e5f1d6f4) - Eric Satterwhite
+* **deps**: eslint-config-codedependant@3.0.0 [6807acc](https://github.com/esatterwhite/semantic-release-docker/commit/6807accd81002e7bc86d79f260c19141f40363f6) - Eric Satterwhite
+* **deps**: eslint@8.5.0 [f7e0bbe](https://github.com/esatterwhite/semantic-release-docker/commit/f7e0bbeb67156dedb0b3a8a2d0bad0d8828c7dde) - Eric Satterwhite
+
+
+### Features
+
+* **template**: replace simple template engine with handlebars [b20c89c](https://github.com/esatterwhite/semantic-release-docker/commit/b20c89ca979de7969028541b6a29ac9b867a06c3) - Eric Satterwhite, closes: [#16](https://github.com/esatterwhite/semantic-release-docker/issues/16)
+
+
+### Miscellaneous
+
+* fix typo [3aa33ba](https://github.com/esatterwhite/semantic-release-docker/commit/3aa33ba2fc003a9f88e6b1d4263999152a577eda) - Eric Satterwhite
+
+
+### **BREAKING CHANGES**
+
+* **template:** Use handlebars as template engine. Place holders are
+now double curlies `{{ }}`
+
+## [3.1.2](https://github.com/esatterwhite/semantic-release-docker/compare/v3.1.1...v3.1.2) (2021-09-18)
+
+
+### Bug Fixes
+
+* **config**: ensure the docker context is passed image builds [366b8d1](https://github.com/esatterwhite/semantic-release-docker/commit/366b8d1d1f90855a76cfdb78009ec4510ead769e) - Eric Satterwhite, closes: [#13](https://github.com/esatterwhite/semantic-release-docker/issues/13)
+
 ## [3.1.1](https://github.com/esatterwhite/semantic-release-docker/compare/v3.1.0...v3.1.1) (2021-09-18)
 
 

package/README.md

@@ -20,7 +20,7 @@ builds a an image using the specified docker file and context. This image will b
 ### publish
 
 pushes the tags Images with specified tags and pushes them to the registry.
-Tags support simple templating. Values enclosed in braces `{}` will be subsititued with release context information
+Tags support simple templating via [handlebars][]. Values enclosed in braces `{{}}` will be substituted with release context information
 
 ## Installation
 
@@ -31,7 +31,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
-omitted, it is assumed the docker daemon is already authenticated with the targe registry.
+omitted, it is assumed the docker daemon is already authenticated with the target registry.
 
 ### Environment variables
 
@@ -42,30 +42,31 @@ omitted, it is assumed the docker daemon is already authenticated with the targe
 
 ### Options
 
-| Option                | Description                                                                                                                                 | Default
-| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------
-| `dockerTags`          | _Optional_. An array of strings allowing to specify additional tags to apply to the image. Supports templating                              | [`latest`, `{major}-latest`, `{version}`]                     |
-| `dockerImage`         | _Optional_. The name of the image to release.                                                                                               | 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 | `null` (dockerhub)                                            |
-| `dockerProject`       | _Optional_. The project or repository name to publish the image to                                                                          | For scoped packages, the scope will be used, otherwise `null` |
-| `dockerFile`    | _Optional_. The path, relative to `$PWD` to a Docker file to build the target image with                                                    | `Dockerfile`                                                  |
-| `dockerContext`       | _Optional_. A path, relative to `$PWD` to use as the build context A                                                                        | `.`                                                           |
-| `dockerLogin`         | _Optional_. Set to false it by pass docker login if the docker daemon is already authorized                                                 | `true`                                                        |
-| `dockerArgs`          | _Optional_. Include additional values for docker's `build-arg`. Supports templating                                                         |                                                               |
-| `dockerPublish`       | _Optional_. Automatically push image tags during the publish phase.                                                                         | `true`                                                        |
+| Option            | Description                                                                                                                                                            | Default                                                       |
+|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|
+| `dockerTags`      | _Optional_. An array of strings allowing to specify additional tags to apply to the image. Supports templating                                                         | [`latest`, `{{major}}-latest`, `{{version}}`]                 |
+| `dockerImage`     | _Optional_. The name of the image to release.                                                                                                                          | 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                            | `null` (dockerhub)                                            |
+| `dockerProject`   | _Optional_. The project or repository name to publish the image to                                                                                                     | For scoped packages, the scope will be used, otherwise `null` |
+| `dockerFile`      | _Optional_. The path, relative to `$PWD` to a Docker file to build the target image with                                                                               | `Dockerfile`                                                  |
+| `dockerContext`   | _Optional_. A path, relative to `$PWD` to use as the build context A                                                                                                   | `.`                                                           |
+| `dockerLogin`     | _Optional_. Set to false it by pass docker login if the docker daemon is already authorized                                                                            | `true`                                                        |
+| `dockerArgs`      | _Optional_. Include additional values for docker's `build-arg`. Supports templating                                                                                    |                                                               |
+| `dockerPublish`   | _Optional_. Automatically push image tags during the publish phase.                                                                                                    | `true`                                                        |
+| `dockerVerifyCmd` | _Optional_. If specified, during the verify stage, the specified command will execute in a container of the build image. If the command errors, the release will fail. | `false`                                                       |
 
 ### Build Arguments
 
 By default several build arguments will be included when the docker images is being built.
 Build arguments can be templated in the same fashion as docker tags. If the value for a
-build argument is explictly `true`, the value will be omitted and the value from
-a matching environment variable will be utilized instead. This can be usefule when trying to include
+build argument is explicitly `true`, the value will be omitted and the value from
+a matching environment variable will be utilized instead. This can be useful when trying to include
 secrets and other sensitive information
 
 | Argument Name       | Description                                                                                | Default                      |
 |---------------------|--------------------------------------------------------------------------------------------|------------------------------|
 | `SRC_DIRECTORY`     | The of the directory the build was triggered from                                          | The directory name of CWD    |
-| `TARGET_PATH`       | Path relative to the execution root. Usefule for Sharing a Single Docker file in monorepos |                              |
+| `TARGET_PATH`       | Path relative to the execution root. Useful for Sharing a Single Docker file in monorepos |                              |
 | `NPM_PACKAGE_NAME`  | The `name` property extracted from `package.json` - if present                             |                              |
 | `NPM_PACKAGE_SCOPE` | The parsed scope from the `name` property from `package.json` - sans `@`                   |                              |
 | `CONFIG_NAME`       | The configured name of the docker image.                                                   | The parsed package name      |
@@ -77,21 +78,44 @@ secrets and other sensitive information
 
 String template will be passed these
 
-| Variable name  | Description                                                        | Type     |
-|----------------|--------------------------------------------------------------------|----------|
-| `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` |
-| `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` |
-| `minor`        | The minor version of the next release                              | `Number` |
-| `patch`        | The patch version of the next release                              | `Number` |
-| `env`          | Environment variables that were set at build time                  | `Object` |
-| `pkg`          | Values parsed from `package.json`                                  | `Object` |
-| `build`        | A Random build hash representing the current execution context     | `String` |
-| `now`          | Current timestamp is ISO 8601 format                               | `String` |
+| Variable name  | Description                                                        | Type            |
+|----------------|--------------------------------------------------------------------|-----------------|
+| `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`        |
+| `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`        |
+| `minor`        | The minor version of the next release                              | `Number`        |
+| `patch`        | The patch version of the next release                              | `Number`        |
+| `prerelease`   | The prerelease versions of the next release                        | `Array<Number>` |
+| `env`          | Environment variables that were set at build time                  | `Object`        |
+| `pkg`          | Values parsed from `package.json`                                  | `Object`        |
+| `build`        | A Random build hash representing the current execution context     | `String`        |
+| `now`          | Current timestamp is ISO 8601 format                               | `String`        |
+
+### Template Helpers
+
+The following handlebars template helpers are pre installed
+
+|  Helper name | Description                                                            | Return Type | Example                                                                                    |
+|:------------:|------------------------------------------------------------------------|:-----------:|--------------------------------------------------------------------------------------------|
+|  `endswith`  | returns true if a string ends with another                             | [Boolean][] | <pre lang="hbs">{{#if (endswith myvar 'ing')}}{{ othervar }}{{/if}}</pre>                  |
+|     `eq`     | returns true if two values are strictly equal to each other            | [Boolean][] | <pre lang="hbs">{{#if (eq var_one var_two)}}{{ var_three }}{{/if}}</pre>                   |
+|     `gt`     | returns true if the first value is greater than the second             | [Boolean][] | <pre lang="hbs">{{#if (gt var_one var_two)}}{{ var_three }}{{/if}}</pre> |
+|     `gte`    | returns true if the first value is greater than or equal to the second | [Boolean][] | <pre lang="hbs">{{#if (gte var_one var_two)}}{{ var_three }}{{/if}}</pre>                  |
+|  `includes`  | returns true if the input (string \| array) includes the second value  | [Boolean][] | <pre lang="hbs">{{#if (includes some_array 'one')}}{{ var_one }}{{/if}}</pre>              |
+|    `lower`   | returns the lower cased varient of the input string                    |  [String][] | <pre lang="hbs">{{ lower my_var }}</pre>                                                   |
+|     `lt`     | returns true if the first value is less than the second                | [Boolean][] | <pre lang="hbs">{{#if (lt var_one var_two)}}{{ var_three }}{{/if}}</pre>                   |
+|     `lte`    | returns true if the first value is less than or equal to the second    | [Boolean][] | <pre lang="hbs">{{#if (lte var_one var_two)}}{{ var_three }}{{/if}}</pre>                  |
+|     `neq`    | returns true if two values are not equal to each other                 | [Boolean][] | <pre lang="hbs">{{#if (neq var_one var_two)}}{{ var_three }}{{/if}}</pre>                  |
+|    `pick`    | returns the first non null-ish value. Will treat `false` as a value    |    `any`    | <pre lang="hbs">{{#with (pick var_one, var_two) as \| value \|}}{{ value }}{{/with}}</pre> |
+|    `split`   | splits csv values into a javascript array                              |  [Array][]  | <pre lang="hbs">{{#each (split csv_value)}}{{ this }}{{/each}}                             |
+| `startswith` | returns true if a string starts with another                           | [Boolean][] | <pre lang="hbs">{{#if (starts myvar 'foo')}}{{ othervar }}{{/if}}</pre>                    |
+|    `upper`   | returns the upper cased varient of the input string                    |  [String][] | <pre lang="hbs">{{upper my_var}}</pre>                                                     |
+
+
 
 ## Usage
 
@@ -104,7 +128,7 @@ module.exports = {
   branches: ['main']
   plugins: [
     ['@codedependant/semantic-release-docker', {
-      dockerTags: ['latest', '{version}', '{major}-latest', '{major}.{minor}'],
+      dockerTags: ['latest', '{{version}}', '{{major}}-latest', '{{major}}.{{minor}}'],
       dockerImage: 'my-image',
       dockerFile: 'Dockerfile',
       dockerRegistry: 'quay.io',
@@ -112,7 +136,7 @@ module.exports = {
       dockerArgs: {
         API_TOKEN: true
       , RELEASE_DATE: new Date().toISOString()
-      , RELEASE_VERSION: '{next.version}'
+      , RELEASE_VERSION: '{{next.version}}'
       }
     }]
   ]
@@ -129,13 +153,13 @@ Alternatively, using global options w/ root configuration
   "version": "1.0.0"
   "release": {
     "extends": "@internal/release-config-docker",
-    "dockerTags": ["latest", "{version}", "{major}-latest", "{major}.{minor}"],
+    "dockerTags": ["latest", "{{version}}", "{{major}}-latest", "{{major}}.{{minor}}"],
     "dockerImage": "my-image",
     "dockerFile": "Dockerfile",
     "dockerRegistry": "quay.io",
     "dockerArgs": {
       "GITHUB_TOKEN": true
-    , "SOME_VALUE": '{git_sha}'
+    , "SOME_VALUE": '{{git_sha}}'
     }
   }
 }
@@ -169,6 +193,24 @@ $ docker push quay.io/codedependant/my-image
 
 the default docker image tags for the 1.0.0 release would be `1.0.0`, `1-latest`, `latest`
 
+**example prerelease configuration**:
+
+```json
+{
+  "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}}"
+    ]
+  }
+}
+```
+
+the docker tags for version `1.2.3` will be `1.2.3`, `1.2-latest`, `1-latest` and `latest`  
+the docker tags for version `2.3.4-beta.6` will be `2.3.4-beta.6`, `2.3-beta`, `2-beta` and `beta`
+
 ## Development
 
 ### Docker Registry
@@ -182,3 +224,8 @@ $ openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout server.key -o
 
 **NOTE**: When prompted for an FQDN it must be `registry:5000`
 **NOTE**: The credentials for the local registry are **user:** `iamweasel`, **pass:** `secretsquirrel`
+
+[handlebars]: https://handlebarsjs.com
+[Boolean]: https://mdn.io/boolean
+[String]: https://mdn.io/string
+[Array]: https://mdn.io/array

package/lib/build-config.js

@@ -13,12 +13,14 @@ async function buildConfig(build_id, config, context) {
   const {
     dockerFile: dockerfile = 'Dockerfile'
   , dockerNoCache: nocache = false
-  , dockerTags: tags = ['latest', '{major}-latest', '{version}']
+  , dockerTags: tags = ['latest', '{{major}}-latest', '{{version}}']
   , dockerArgs: args = {}
   , dockerRegistry: registry = null
   , dockerLogin: login = true
   , dockerImage: image
   , dockerPublish: publish = true
+  , dockerContext = '.'
+  , dockerVerifyCmd: verifycmd = null
   } = config
 
   let name = null
@@ -43,6 +45,7 @@ async function buildConfig(build_id, config, context) {
   , project
   , publish
   , tags: array.toArray(tags)
+  , verifycmd
   , args: {
       SRC_DIRECTORY: path.basename(context.cwd)
     , TARGET_PATH: target
@@ -58,6 +61,6 @@ async function buildConfig(build_id, config, context) {
   , build: build_id
   , login: login
   , env: context.env
-  , context: config.context || '.'
+  , context: dockerContext
   }
 }

package/lib/docker/image.js

@@ -3,6 +3,7 @@
 const path = require('path')
 const crypto = require('crypto')
 const execa = require('execa')
+const array = require('../lang/array/index.js')
 
 class Image {
   constructor(opts) {
@@ -53,7 +54,7 @@ class Image {
   }
 
   get context() {
-    return this.opts.context
+    return path.resolve(this.opts.cwd, this.opts.context)
   }
 
   set context(ctx) {
@@ -79,7 +80,7 @@ class Image {
         args.push('--build-arg', `${name}=${value}`)
       }
     }
-    const cmd = [
+    return [
       'build'
     , '--quiet'
     , '--tag'
@@ -89,7 +90,21 @@ class Image {
     , this.dockerfile
     , this.context
     ]
-    return cmd
+  }
+
+  async run(cmd) {
+    const stream = execa('docker', [
+      'run'
+    , '--rm'
+    , this.name
+    , ...array.toArray(cmd)
+    ], {all: true})
+
+    stream.stdout.pipe(process.stdout)
+    stream.stderr.pipe(process.stderr)
+
+    const {all} = await stream
+    return all
   }
 
   async build() {

package/lib/handlebars/helpers/endswith.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = endsWith
+
+function endsWith(str, ...args) {
+  if (typeof str !== 'string') return false
+  return args.some((arg) => {
+    return str.endsWith(arg)
+  })
+}

package/lib/handlebars/helpers/eq.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = eq
+
+function eq(lh, rh) {
+  return lh === rh
+}

package/lib/handlebars/helpers/gt.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = gt
+
+function gt(lh, rh) {
+  return lh > rh
+}

package/lib/handlebars/helpers/gte.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = gte
+
+function gte(lh, rh) {
+  return lh >= rh
+}

package/lib/handlebars/helpers/includes.js

@@ -0,0 +1,9 @@
+'use strict'
+
+module.exports = includes
+
+function includes(input, arg, position) {
+  if (!Array.isArray(input) && typeof input !== 'string') return false
+  return input.includes(arg, position)
+}
+

package/lib/handlebars/helpers/index.js

@@ -0,0 +1,17 @@
+'use strict'
+
+module.exports = {
+  endswith: require('./endswith')
+, eq: require('./eq')
+, gt: require('./gt')
+, gte: require('./gte')
+, includes: require('./includes')
+, lower: require('./lower')
+, lt: require('./lt')
+, lte: require('./lte')
+, neq: require('./neq')
+, pick: require('./pick')
+, startswith: require('./startswith')
+, split: require('./split')
+, upper: require('./upper')
+}

package/lib/handlebars/helpers/lower.js

@@ -0,0 +1,8 @@
+'use strict'
+
+module.exports = lower
+
+function lower(str) {
+  if (typeof str !== 'string') return ''
+  return str.toLowerCase()
+}

package/lib/handlebars/helpers/lt.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = lt
+
+function lt(lh, rh) {
+  return lh < rh
+}

package/lib/handlebars/helpers/lte.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = lte
+
+function lte(lh, rh) {
+  return lh < rh
+}

package/lib/handlebars/helpers/neq.js

@@ -0,0 +1,9 @@
+'use strict'
+
+module.exports = neq
+
+function neq(lh, rh) {
+  /* eslint-disable eqeqeq */
+  return lh != rh
+  /* eslint-enable eqeqeq */
+}

package/lib/handlebars/helpers/pick.js

@@ -0,0 +1,13 @@
+'use strict'
+
+module.exports = pick
+
+function pick(...args) {
+  return args.find((value) => {
+    /* eslint-disable no-eq-null */
+    if (value == null) return false
+    /* eslint-enable no-eq-null */
+    if (value === '') return false
+    return true
+  })
+}

package/lib/handlebars/helpers/split.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = require('../../lang/array/to-array.js')
+
+

package/lib/handlebars/helpers/startswith.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = startsWith
+
+function startsWith(str, ...args) {
+  if (typeof str !== 'string') return false
+  return args.some((arg) => {
+    return str.startsWith(arg)
+  })
+}

package/lib/handlebars/helpers/upper.js

@@ -0,0 +1,9 @@
+
+'use strict'
+
+module.exports = upper
+
+function upper(str) {
+  if (typeof str !== 'string') return ''
+  return str.toUpperCase()
+}

package/lib/handlebars/index.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const Handlebars = require('handlebars')
+const helpers = require('./helpers')
+const handlebars = Handlebars.noConflict()
+
+handlebars.registerHelper(helpers)
+
+module.exports = handlebars
+

package/lib/lang/string/template.js

@@ -1,14 +1,16 @@
 'use strict'
-const object = require('../object/index.js')
+
+const handlebars = require('../../handlebars')
 
 module.exports = template
 
 function template(str) {
-  return function interpolate(values) {
-    if (typeof str !== 'string') return str
-    return str.replace(/{([^{}]*)}/g, function(original, parsed) {
-      const result = object.get(values, parsed)
-      return typeof result === 'string' || typeof result === 'number' ? result : original
-    })
+  if (typeof str !== 'string') return echo(str)
+  return handlebars.compile(str)
+}
+
+function echo(input) {
+  return () => {
+    return input
   }
 }

package/lib/prepare.js

@@ -16,6 +16,7 @@ async function dockerPrepare(opts, context) {
   , dockerfile: opts.dockerfile
   , build_id: opts.build
   , cwd: cwd
+  , context: opts.context
   })
 
   const args = {

package/lib/publish.js

@@ -15,6 +15,7 @@ async function publish(opts, context) {
   , dockerfile: opts.dockerfile
   , build_id: opts.build
   , cwd: cwd
+  , context: opts.context
   })
 
   const vars = buildTemplateVars(opts, context)