dip 8.2.5 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ca40663a00675570ed4dcd668987e7845c6a3d9682b999889c9af37368cfea
-  data.tar.gz: c9eb17ad1d6f9615868f04024afb434a821a758bffa48daac1516a1cd99b10e7
+  metadata.gz: b1251c437797a56125f593a350dde6c3709f70936a6cc274949d0b2b58dd814f
+  data.tar.gz: d1e4d3484bdc41ed6281d14a7ce324146cd1768989c3e3f3fa09fc412d72bf2d
 SHA512:
-  metadata.gz: 4fc103b4c4e0f22c58d4b87e9d1b48a61f95bd948b9b00e7afbaaf453c0d11ef5720d698e11376837f032e35639058f9e47cd74716a2f7274da00c868589110a
-  data.tar.gz: 13a8525d318c4e312287d136005b0bf6c751f11f85f984de5266c2222aa432deb44eb0173172305739022fe654770290dea07b712b1a1b029015782a2582d38d
+  metadata.gz: 1dafa2c574e88f414a498ed0e3cbeaab047085ee0232977fcf1900ef92637c333cab39dc9d9ae1e5eaf93843949e3bd62a9c61f23f46ba83711cd0aecf83412c
+  data.tar.gz: 3ce49864159703c73ac8811a5a9f8d295192f3dc0be569a7d6708a5084013a2464de89b67cb1982edd888dec7284d44761959b85fa02b62e23b95547b5ef70fc

data/README.md

@@ -12,7 +12,7 @@ The dip is a CLI dev–tool that provides native-like interaction with a Dockeri
 ## Presentations and examples
 
 - [Local development with Docker containers](https://slides.com/bibendi/dip)
-- [Dockerized Ruby on Rails application](https://SberMarket-Tech/outbox-example-apps)
+- [Dockerized Ruby on Rails application](https://github.com/Kuper-Tech/outbox-example-apps)
 - Dockerized Node.js application: [one](https://github.com/bibendi/twinkle.js), [two](https://github.com/bibendi/yt-graphql-react-event-booking-api)
 - [Dockerized Ruby gem](https://github.com/bibendi/schked)
 - [Dockerizing Ruby and Rails development](https://evilmartians.com/chronicles/ruby-on-whales-docker-for-ruby-rails-development)
@@ -20,6 +20,14 @@ The dip is a CLI dev–tool that provides native-like interaction with a Dockeri
 
 [![asciicast](https://asciinema.org/a/210236.svg)](https://asciinema.org/a/210236)
 
+## Quick start with AI
+
+[dip-skill](https://github.com/kalashnikovisme/dip-skill) helps you quickly configure a `dip` environment for your project. It detects the tech stack and bootstraps `dip.yml`, compose files, and Dockerfiles.
+
+```sh
+npx skills add kalashnikovisme/dip-skill
+```
+
 ## Installation
 
 ```sh
@@ -66,12 +74,12 @@ dip SUBCOMMAND --help
 
 ### dip.yml
 
-The configuration is loaded from `dip.yml` file. It may be located in a working directory, or it will be found in the nearest parent directory up to the file system root. If nearby places `dip.override.yml` file, it will be merged into the main config.
+The configuration is loaded from `dip.yml` file. It may be located in a working directory, or it will be found in the nearest parent directory up to the file system root. If a `dip.override.yml` file exists nearby, it will be merged into the main config.
 
 Also, in some cases, you may want to change the default config path by providing an environment variable `DIP_FILE`.
 
 Below is an example of a real config.
-Config file reference will be written soon.
+The schema is defined in `schema.json` and can be validated with `dip validate`.
 Also, you can check out examples at the top.
 
 ```yml
@@ -178,13 +186,21 @@ provision:
   - dip clean_cache
   - dip compose up -d pg redis
   - dip bash -c ./bin/setup
+
+preflight:
+  - ./bin/check-credentials
+  - test -f .env
 ```
 
+`preflight` is an array of shell commands that dip runs before any command that touches a running container or cluster: `dip compose ...` (and its aliases `dip up`, `dip build`, `dip stop`, `dip down`), `dip ktl ...`, and `dip run ...` (including the interaction shorthand `dip <name>`). If any command exits non-zero, dip aborts before the underlying operation runs. Useful for verifying credentials are present, required files exist, env vars are set, etc.
+
+Not triggered by `dip down --all` (cross-project teardown), `dip ssh`, `dip infra`, or `dip provision`.
+
 ### Predefined environment variables
 
 #### $DIP_OS
 
-Current OS architecture (e.g. `linux`, `darwin`, `freebsd`, and so on). Sometime it may be useful to have one common `docker-compose.yml` and OS-dependent Compose configs.
+Current OS name (e.g. `linux`, `darwin`, `freebsd`, and so on). Sometimes it may be useful to have one common `docker-compose.yml` and OS-dependent Compose configs.
 
 #### $DIP_WORK_DIR_REL_PATH
 
@@ -240,7 +256,7 @@ The container will run using the same user ID as your host machine.
 
 ### Modules
 
-Modules are defined as array in `modules` section of dip.yml, modules are stored in `.dip` subdirectory of dip.yml directory.
+Modules are defined as an array in the `modules` section of dip.yml. Module files are stored in the `.dip` subdirectory next to dip.yml.
 
 The main purpose of modules is to improve maintainability for a group of projects.
 Imagine having multiple gems which are managed with dip, each of them has the same commands, so to change one command in dip you need to update all gems individualy.
@@ -328,7 +344,7 @@ Nested modules are not supported.
 
 Run commands defined within the `interaction` section of dip.yml
 
-A command will be executed by specified runner. Dip has three types of them:
+A command will be executed by the specified runner. You can set the runner explicitly via the `runner` key (e.g. `runner: docker_compose`). Otherwise dip picks the runner automatically:
 
 - `docker compose` runner — used when the `service` option is defined.
 - `kubectl` runner — used when the `pod` option is defined.
@@ -436,7 +452,7 @@ STAGE=some dip ktl get pods
 
 Runs ssh-agent container based on https://github.com/whilp/ssh-agent with your ~/.ssh/id_rsa.
 It creates a named volume `ssh_data` with ssh socket.
-An application's docker-compose.yml should contains environment variable `SSH_AUTH_SOCK=/ssh/auth/sock` and connects to external volume `ssh_data`.
+An application's docker-compose.yml should contain the environment variable `SSH_AUTH_SOCK=/ssh/auth/sock` and connect the external volume `ssh_data`.
 
 ```sh
 dip ssh up
@@ -492,7 +508,6 @@ If validation fails, you'll get detailed error messages indicating what needs to
 You can skip validation by setting `DIP_SKIP_VALIDATION` environment variable.
 
 Add `# yaml-language-server: $schema=https://raw.githubusercontent.com/bibendi/dip/refs/heads/master/schema.json` to the top of your dip.yml to get schema validation in VSCode. Read more about [YAML Language Server](https://github.com/redhat-developer/vscode-yaml?tab=readme-ov-file#associating-schemas).
-
 ## Changelog
 
-https://github.com/bibendi/dip/releases
+See [CHANGELOG.md](CHANGELOG.md).

data/lib/dip/cli.rb

@@ -49,7 +49,10 @@ module Dip
 
     desc "compose CMD [OPTIONS]", "Run Docker Compose commands"
     def compose(*argv)
+      require_relative "commands/preflight"
       require_relative "commands/compose"
+
+      Dip::Commands::Preflight.new.execute
       Dip::Commands::Compose.new(*argv).execute
     end
 
@@ -84,7 +87,10 @@ module Dip
 
     desc "ktl CMD [OPTIONS]", "Run kubectl commands"
     def ktl(*argv)
+      require_relative "commands/preflight"
       require_relative "commands/kubectl"
+
+      Dip::Commands::Preflight.new.execute
       Dip::Commands::Kubectl.new(*argv).execute
     end
 
@@ -96,8 +102,10 @@ module Dip
       if argv.empty? || options[:help]
         invoke :help, ["run"]
       else
+        require_relative "commands/preflight"
         require_relative "commands/run"
 
+        Dip::Commands::Preflight.new.execute
         Dip::Commands::Run.new(
           *argv,
           **options.to_h.transform_keys!(&:to_sym)

data/lib/dip/commands/list.rb

@@ -12,7 +12,7 @@ module Dip
         longest_name = tree.keys.map(&:size).max
 
         tree.each do |name, command|
-          puts "#{name.ljust(longest_name)}  ##{command[:description] ? " #{command[:description]}" : ""}"
+          puts "#{name.ljust(longest_name)}  ##{" #{command[:description]}" if command[:description]}"
         end
       end
     end

data/lib/dip/commands/preflight.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+
+module Dip
+  module Commands
+    class Preflight < Dip::Command
+      def execute
+        Dip.config.preflight.each do |command|
+          exec_subprocess(command)
+        end
+      end
+    end
+  end
+end

data/lib/dip/config.rb

@@ -20,10 +20,11 @@ module Dip
       kubectl: {},
       infra: {},
       interaction: {},
-      provision: []
+      provision: [],
+      preflight: []
     }.freeze
 
-    TOP_LEVEL_KEYS = %i[environment compose kubectl infra interaction provision].freeze
+    TOP_LEVEL_KEYS = %i[environment compose kubectl infra interaction provision preflight].freeze
 
     ConfigKeyMissingError = Class.new(ArgumentError)
 

data/lib/dip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dip
-  VERSION = "8.2.5"
+  VERSION = "8.3.0"
 end

data/schema.json

@@ -175,6 +175,16 @@
         ]
       ]
     },
+    "preflight": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Shell commands to run before any `dip compose` subcommand. A non-zero exit aborts the command.",
+      "examples": [
+        ["./bin/check-credentials", "test -f .env"]
+      ]
+    },
     "environment": {
       "$ref": "#/definitions/environment_vars"
     },

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 8.2.5
+  version: 8.3.0
 platform: ruby
 authors:
 - bibendi
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -154,14 +153,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +231,7 @@ files:
 - lib/dip/commands/infra/service.rb
 - lib/dip/commands/kubectl.rb
 - lib/dip/commands/list.rb
+- lib/dip/commands/preflight.rb
 - lib/dip/commands/provision.rb
 - lib/dip/commands/run.rb
 - lib/dip/commands/runners/base.rb
@@ -252,7 +252,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -267,8 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby gem CLI tool for better interacting Docker Compose files.
 test_files: []