dip 8.2.6 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2024ed1872b11b03b134cef94a5e15bd0525f93ab6e61de7bf6cfe971b43ebd
-  data.tar.gz: 13100418400bb01c4a1843559b7349aae4468a802ed9ea0ba2536840f11a9eb8
+  metadata.gz: b1251c437797a56125f593a350dde6c3709f70936a6cc274949d0b2b58dd814f
+  data.tar.gz: d1e4d3484bdc41ed6281d14a7ce324146cd1768989c3e3f3fa09fc412d72bf2d
 SHA512:
-  metadata.gz: d018d6a84f98cd8778a9672f6764ca80ffdd590738b4f3649c1176f586f2dcf8679cb365576211fb094d008410a69ff9160642354de396973392761498d694ba
-  data.tar.gz: f2eb077654301b798ef2ff43a93b610c3ddea668e437cc016c22944b8acb3a546fe259f42cd1f3366cca114c799e8c939cd670f140f8163e578c535413f5c064
+  metadata.gz: 1dafa2c574e88f414a498ed0e3cbeaab047085ee0232977fcf1900ef92637c333cab39dc9d9ae1e5eaf93843949e3bd62a9c61f23f46ba83711cd0aecf83412c
+  data.tar.gz: 3ce49864159703c73ac8811a5a9f8d295192f3dc0be569a7d6708a5084013a2464de89b67cb1982edd888dec7284d44761959b85fa02b62e23b95547b5ef70fc

data/README.md

@@ -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
@@ -178,8 +186,16 @@ 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
@@ -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
 
 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/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.6"
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 8.2.6
+  version: 8.3.0
 platform: ruby
 authors:
 - bibendi
@@ -231,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