@verdnatura/myt 2.0.1 → 2.0.3

package/README.md

@@ -9,7 +9,7 @@ development, so any help is welcomed! Feel free to contribute.
 ## Requirements
 
 * Git
-* Docker (Optional, used to manage local server)
+* Docker >= 23 with BuildKit (Optional, used to manage local server)
 
 ## Installation
 
@@ -62,7 +62,13 @@ Local server management commands:
  * **run**: Build and start local database server container.
  * **start**: Start local database server container.
 
-Each command can have its own specific commandline options.
+Each command can have its own specific commandline options, you can see them by
+running the command along with the _--help_ parameter, only the most commonly
+used ones are documented here.
+
+```text
+$ myt <command> [<args>] [-h|--help]
+```
 
 ### Usage as library
 
@@ -225,16 +231,15 @@ should be named like this: `filename.foo.sql`.
 Initializes an empty workspace.
 
 ```text
-$ myt init
+$ myt init [<args>]
 ```
 
-
 ### pull
 
 Incorporates database routine changes into workspace.
 
 ```text
-$ myt pull [remote] [-f|--force] [-c|--checkout] [-u|--update] [-s|--sums]
+$ myt pull [<args>] [-f|--force] [<remote>]
 ```
 
 When *--checkout* option is provided, it does the following before export:
@@ -247,7 +252,7 @@ When *--checkout* option is provided, it does the following before export:
 Applies versions and routine changes into database.
 
 ```text
-$ myt push [<remote>] [-f|--force] [-c|--commit] [-s|--sums] [-t|--triggers]
+$ myt push [<args>] [-f|--force] [-c|--commit] [<remote>]
 ```
 
 Commit is saved into database only if *--commit* option is provided, it
@@ -261,7 +266,7 @@ Creates a new version folder, when name is not specified it generates a random
 name mixing a color with a plant name.
 
 ```text
-$ myt version [<name>]
+$ myt version [<args>] [<name>]
 ```
 
 ### create
@@ -269,7 +274,7 @@ $ myt version [<name>]
 Creates a new routine file with a default template.
 
 ```text
-$ myt create [-t <type>] <schema>.<name>
+$ myt create [<args>] [-t <type>] <schema>.<name>
 ```
 
 ### clean
@@ -288,7 +293,7 @@ Exports database structure and fixtures from remote into hidden files located
 in *dump* folder. If no remote is specified *production* is used.
 
 ```text
-$ myt dump [<remote>] [-l|--lock] [-t|--triggers]
+$ myt dump [<args>] [-l|--lock] [<remote>]
 ```
 
 ### fixtures
@@ -297,7 +302,7 @@ Exports local database fixtures into *dump/fixtures.sql* files. If no remote is
 specified *local* is used.
 
 ```text
-$ myt fixtures [<remote>]
+$ myt fixtures [<args>] [<remote>]
 ```
 
 ### build
@@ -306,7 +311,7 @@ Builds local database server image. It only rebuilds the image when sources
 have been modified.
 
 ```text
-$ myt build [-n|--name] [-t|--tag] [-f|--force] [-m|--realm <string>]
+$ myt build [<args>] [-n|--name] [-t|--tag] [-f|--force] [<realm>]
 ```
 
 ### apply
@@ -315,7 +320,7 @@ Applies structure, fixtures and changes to database. Primarily used by the
 build command to rebuild the local database.
 
 ```text
-$ myt apply [-s|--structure] [-c|--changes] [-m|--realm <string>] [-l|--load <string>]
+$ myt apply [<args>] [<realm>]
 ```
 
 ### run
@@ -324,7 +329,7 @@ Builds and starts local database server container. It only rebuilds the image
 when dump have been modified.
 
 ```text
-$ myt run [<realm>|-m|--realm <string>] [-c|--ci] [-r|--random] [-p|--persist] [-k|--keep] [-n|--network <string>] [-i|--ip]
+$ myt run [<args>] [-c|--ci] [-r|--random] [<realm>]
 ```
 
 ### start
@@ -335,7 +340,7 @@ mind that when you do not rebuild the docker you may be using an outdated
 version of it.
 
 ```text
-$ myt start
+$ myt start [<args>]
 ```
 
 ## Why

package/docker/server/Dockerfile.myt

@@ -23,11 +23,8 @@ RUN apt-get update \
 #     && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /myt
-COPY pnpm-lock.yaml ./
-RUN pnpm fetch --prod --frozen-lockfile --ignore-scripts
-
 COPY package.json ./
-RUN pnpm install --prod --frozen-lockfile --ignore-scripts
+RUN pnpm install --prod --ignore-scripts
 
 COPY . ./
 RUN npm install -g /myt

package/myt-build.js

@@ -133,13 +133,8 @@ class Build extends Command {
         const tagSha = tagHash.digest('hex');
         const shortSha = tagSha.substring(0, cfg.gitShortLen);
 
-        let imageTag = 'latest';
-        if (opts.tag) {
-            imageTag = opts.tag;
-        } else if (shortSha) {
-            imageTag = shortSha;
-            if (realm) imageTag += `-${realm}`;
-        }
+        let imageTag = shortSha;
+        if (realm) imageTag += `-${realm}`;
 
         const imageName = opts.name || cfg.code;
         const tag = `${imageName}:${imageTag}`;
@@ -262,8 +257,12 @@ class Build extends Command {
                 if (realm)
                     buildArgs.push(`MYT_REALM=${realm}`);
 
+                const tags = [tag, `${imageName}:latest`];
+                if (opts.tag)
+                    tags.push(`${imageName}:${opts.tag}`);
+
                 await docker.build(ctx.mytDir, {
-                    tag: [tag, imageName],
+                    tag: tags,
                     file: path.join(serverDir, 'Dockerfile'),
                     label: imageLabels,
                     buildArg: buildArgs

package/myt-run.js

@@ -13,36 +13,46 @@ class Run extends Command {
     static usage = {
         description: 'Build and start local database server container',
         params: {
-            ci: 'Workaround for continuous integration system',
             network: 'Docker network to attach container to',
             random: 'Whether to use a random container name and port',
             persist: 'Whether to not use tmpfs mount for MySQL data',
             keep: 'Keep container on failure',
             realm: 'Name of fixture realm to use',
-            ip: 'Bind to container IP instead of localhost'
+            ip: 'Bind to container IP instead of localhost',
+            build: 'Whether to skip image build',
+            name: 'Built image name',
+            tag: 'Built image tag',
+            force: 'Whether to force build'
         },
         operand: 'realm'
     };
 
     static args = {
         alias: {
-            network: 'n',
+            network: 'e',
             random: 'r',
             persist: 'p',
             keep: 'k',
-            realm: 'm',
-            ip: 'i'
+            ip: 'i',
+            build: 'b',
+            name: 'n',
+            tag: 't',
+            force: 'f',
+            realm: 'm'
         },
         string: [
             'network',
+            'name',
+            'tag',
             'realm'
         ],
         boolean: [
-            'ci',
             'random',
             'persist',
             'keep',
-            'ip'
+            'ip',
+            'build',
+            'force'
         ]
     };
 
@@ -55,9 +65,21 @@ class Run extends Command {
     };
 
     async _run(myt, ctx, cfg, opts) {
-        const tag = await myt.run(Build, {
-            realm: opts.realm
-        });
+        let tag;
+
+        if (!opts.build) {
+            tag = await myt.run(Build, {
+                name: opts.name,
+                tag: opts.tag,
+                force: opts.force,
+                realm: opts.realm
+            });
+        } else {
+            if (!opts.name)
+                throw new Error('Build ommitted but no image passed');
+            tag = opts.name;
+            if (opts.tag) tag += `:${opts.tag}`;
+        }
 
         this.emit('runningContainer');
 

package/myt.js

@@ -125,7 +125,7 @@ class Myt {
             }
 
             if (opts.help) {
-                this.showHelp(Command.opts, Command.usage, commandName);
+                this.showHelp(Command.args, Command.usage, commandName);
                 process.exit(0);
             }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdnatura/myt",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "author": "Verdnatura Levante SL",
   "description": "MySQL version control",
   "license": "GPL-3.0",