release-it-docker-plugin 0.0.2 → 0.0.5

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Filip Gulan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# Release It! 🚀 - Docker plugin
+
+Plugin to ability build docker images and push to docker hub in release-it workflow.
+
+# Options
+| Name      | Default value | Description                                      |
+|-----------|---------------|--------------------------------------------------|
+| build     | false         | if plugin should build docker image              |
+| push      | false         | if plugin should push docker image to docker hub |
+| latestTag | false         | if also `latest` tag should be built and pushed  |
+| imageName | undefined     | name of docker image to build and push           |
+
+## Example
+
+```json
+{
+  "$schema": "https://unpkg.com/release-it/schema/release-it.json",
+  "plugins": {
+    "release-it-docker-plugin": {
+      "build": true,
+      "push": true,
+      "latestTag": true,
+      "imageName": "<YOUR_IMAGE_NAME>"
+    }
+  }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it-docker-plugin",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "",
   "keywords": [],
   "repository": "",

package/src/index.js

@@ -1,22 +1,46 @@
-import {BasePlugin} from "./base-plugin";
+import { debug } from 'node:util';
+import _ from 'lodash';
 
 const DOCKER_HUB_BASE_URL = 'https://hub.docker.com';
 
-export default class DockerPlugin extends BasePlugin {
+export default class DockerPlugin {
+
+    static isEnabled() {
+        return true;
+    }
+
+    static disablePlugin() {
+        return null;
+    }
+
+    constructor({ namespace, options = {}, container = {} } = {}) {
+        this.namespace = namespace;
+        this.options = Object.freeze(this.getInitialOptions(options, namespace));
+        this.context = {};
+        this.config = container.config;
+        this.log = container.log;
+        this.shell = container.shell;
+        this.spinner = container.spinner;
+        this.prompt = container.prompt;
+        this.debug = debug(`release-it:${namespace}`);
+
+        this.registerPrompts({
+            build: {type: 'confirm', message: () => 'Build docker image?', default: !!this.options.build},
+            push: {type: 'confirm', message: () => 'Push to docker hub?', default: !!this.options.push},
+        });
+    }
 
     async beforeRelease() {
-        if (this.options.build === false) return false;
-        return this.step({ task: () => this.build(), label: 'docker build', prompt: {message: 'Build?', default: this.options.build}});
+        return this.step({ task: () => this.build(), label: 'docker build', prompt: 'build'});
     }
 
     async release() {
-        if (this.options.publish === false) return false;
-        return this.step({ task: () => this.publish(), label: 'docker publish', prompt: {message: 'Publish?', default: this.options.publish} });
+        return this.step({ task: () => this.push(), label: 'docker push', prompt: 'push'});
     }
 
     afterRelease() {
-        const { isPublished } = this.getContext();
-        if (isPublished) {
+        const { isPushed } = this.getContext();
+        if (isPushed) {
             this.log.log(`🔗 ${DOCKER_HUB_BASE_URL}/r/${this.options.imageName}`);
         }
     }
@@ -24,7 +48,7 @@ export default class DockerPlugin extends BasePlugin {
     build() {
         const { imageName, latestTag } = this.options;
         const args = [
-            '-t', `${imageName}:${this.getContext().version}`,
+            '-t', `${imageName}:${this.config.contextOptions.version}`,
             ...(latestTag ? ['-t', `${imageName}:latest`] : [])
         ];
         return this.exec(`docker build ${args.filter(Boolean).join(' ')} .`).then(
@@ -36,17 +60,61 @@ export default class DockerPlugin extends BasePlugin {
         );
     }
 
-    publish() {
+    push() {
         const { imageName, latestTag } = this.options;
         return Promise.all([
-            this.exec(`docker push ${imageName}:${this.getContext().version}`),
+            this.exec(`docker push ${imageName}:${this.config.contextOptions.version}`),
             latestTag ? this.exec(`docker push ${imageName}:latest`) : Promise.resolve(),
         ]).then(
-            () => this.setContext({ isPublished: true }),
+            () => this.setContext({ isPushed: true }),
             (err) => {
                 this.debug(err);
                 throw new Error(err);
             }
         );
     }
+
+    getInitialOptions(options, namespace) {
+        return options[namespace] || {};
+    }
+
+    init() {}
+    getName() {}
+    getLatestVersion() {}
+    getChangelog() {}
+    getIncrement() {}
+    getIncrementedVersionCI() {}
+    getIncrementedVersion() {}
+    beforeBump() {}
+    bump() {}
+
+    getContext(path) {
+        const context = _.merge({}, this.options, this.context);
+        return path ? _.get(context, path) : context;
+    }
+
+    setContext(context) {
+        _.merge(this.context, context);
+    }
+
+    exec(command, { options, context = {} } = {}) {
+        const ctx = Object.assign(context, this.config.getContext(), { [this.namespace]: this.getContext() });
+        return this.shell.exec(command, options, ctx);
+    }
+
+    registerPrompts(prompts) {
+        this.prompt.register(prompts, this.namespace);
+    }
+
+    async showPrompt(options) {
+        options.namespace = this.namespace;
+        return this.prompt.show(options);
+    }
+
+    step(options) {
+        const context = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
+        const opts = Object.assign({}, options, { context });
+        const isException = this.config.isPromptOnlyVersion && ['incrementList', 'publish', 'otp'].includes(opts.prompt);
+        return this.config.isCI && !isException ? this.spinner.show(opts) : this.showPrompt(opts);
+    }
 }

package/src/base-plugin.js

@@ -1,75 +0,0 @@
-import { debug } from 'node:util';
-import _ from 'lodash';
-
-// I was unable to import plugin class from release-it v18, so I copied and pasted it here and typed a bit for my use case.
-// See: https://github.com/release-it/release-it/blob/main/lib/plugin/Plugin.js
-class Plugin {
-    static isEnabled() {
-        return true;
-    }
-
-    static disablePlugin() {
-        return null;
-    }
-
-    constructor({ namespace, options = {}, container = {} } = {}) {
-        this.namespace = namespace;
-        this.options = Object.freeze(this.getInitialOptions(options, namespace));
-        this.context = {};
-        this.config = container.config;
-        this.log = container.log;
-        this.shell = container.shell;
-        this.spinner = container.spinner;
-        this.prompt = container.prompt;
-        this.debug = debug(`release-it:${namespace}`);
-    }
-
-    getInitialOptions(options, namespace) {
-        return options[namespace] || {};
-    }
-
-    init() {}
-    getName() {}
-    getLatestVersion() {}
-    getChangelog() {}
-    getIncrement() {}
-    getIncrementedVersionCI() {}
-    getIncrementedVersion() {}
-    beforeBump() {}
-    bump() {}
-    beforeRelease() {}
-    release() {}
-    afterRelease() {}
-
-    getContext(path) {
-        const context = _.merge({}, this.options, this.context);
-        return path ? _.get(context, path) : context;
-    }
-
-    setContext(context) {
-        _.merge(this.context, context);
-    }
-
-    exec(command, { options, context = {} } = {}) {
-        const ctx = Object.assign(context, this.config.getContext(), { [this.namespace]: this.getContext() });
-        return this.shell.exec(command, options, ctx);
-    }
-
-    registerPrompts(prompts) {
-        this.prompt.register(prompts, this.namespace);
-    }
-
-    async showPrompt(options) {
-        options.namespace = this.namespace;
-        return this.prompt.show(options);
-    }
-
-    step(options) {
-        const context = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
-        const opts = Object.assign({}, options, { context });
-        const isException = this.config.isPromptOnlyVersion && ['incrementList', 'publish', 'otp'].includes(opts.prompt);
-        return this.config.isCI && !isException ? this.spinner.show(opts) : this.showPrompt(opts);
-    }
-}
-
-export default Plugin;