capistrano-addon-fm 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd77cf936fe7b355ceef1d43344d55af39f0040afaebdc441154e2571df8280
-  data.tar.gz: 6430cd5a453b92599abe528d09fdac247719f1bcca27a9d6e8ed93fd42aecef3
+  metadata.gz: 334ec6e155c84a16a1ef01dd5d5690dac733f0d6b9be61179226ae5a25804531
+  data.tar.gz: 613cb974e55564802a58db41882838d622693fb91892b7e21bcdb47d915df59a
 SHA512:
-  metadata.gz: c6e61dc7bab5dfe662f80b1ecc857c9f4241bf2f8ade82f42122ef3676edd221411fd4de924ccd4de553ff513b450ce5f26a0a8e0c9de298d8a09d2bb417dfa4
-  data.tar.gz: d7f8490624c7f01adbb261cc159e335f27c87aa42fc140e1b96c6fa94dc0466120ce4a8cc215542e2b4de32796926de01ebd696bd10a5143dc5f2e253c73d311
+  metadata.gz: 27a03eea721ae51d58e143e716e26981972fd312ec82caefeb6e4412c3f454ed8f4df866e113cdd27debd5498f6724210e662069483a10b5c9ec325eb2c6a456
+  data.tar.gz: ae2795ee3834162a4a41a802257b14ab27f197aaf9c38c61a38360b0c095b5a099b12f3a948227f5e404486b6c02ebace3d36ceba3ecc1abef3985e947e18eeb

data/CHANGELOG.md

@@ -1,9 +1,26 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.1.4] - 2026-06-20
+### Added
+- add `cap fm:version` task that will output addon readme file 
+- env-with-secrets : add 2 new tasks : `env:set` and `env:set:diff` - same as `env:upload`/`env:upload:diff` but with remote instead of local .env.smth file
+
+## [0.1.3] - 2025-08-26
+### Added
+- fix env-with-secrets : fix release_path (latest)
+- add `cap fm:readme` task that will output addon readme file
+- add `cap fm:readme:tasks` task that will output addon readme file - only tasks part
+- improved readme.md docs 
+
+## [0.1.2] - 2025-02-18
+### Added
+- fix env-with-secrets; add missing php-fpm README text
+
 ## [0.1.1] - 2025-02-18
 ### Added
 - add php-fpm tasks
-## [0.1.0] - 2025-02-18
+
+## [0.1.0] - 2025-02-17
 ### Added
 - add generic tasks - documented in README.md

data/README.md

@@ -17,6 +17,10 @@ require 'capistrano/addon/fm'
 ## Usage
 
 ### this will add new tasks for `cap` command
+#### addon related commands (no stage needed):
+    cap fm:version                                      Will output this readme file
+    cap fm:readme                                       Will output this readme file
+    cap fm:readme:tasks                                 Will output this readme file - only Usage block
 new tasks (example run: cap prod TASK - replace 'prod' with your stage (devel/local/etc))
 #### supervisor related commands:
     cap prod supervisor:start                           Will run supervisorctl `start all`
@@ -57,11 +61,13 @@ new tasks (example run: cap prod TASK - replace 'prod' with your stage (devel/lo
     cap prod system:disk_space: all|df|zfs|btrfs
     cap prod system:connections:count: total|per_address|via_ss
 #### env-with-secrets:
-    cap env:upload                                      Will upload .env file to server and decrypt
-    cap env:upload:diff                                 Will run `diff` command to server's .env versus local .env - decrypted
-    cap env:local:encrypt_file                          Will encrypt `cap-secrets-LOCAL.txt` to `ap-secrets.enc.b64`
-    cap env:local:decrypt_file                          Will decrypt `ap-secrets.enc.b64` into `cap-secrets-LOCAL.txt`
-    cap env:local:secrets                               cat `cap-secrets-LOCAL.txt`
+    cap prod env:set                                         Will set server's .env.smth file to server's .env and decrypt
+    cap prod env:set:diff                                    Will run `diff` command to server's .env versus server's .env.smth - decrypted
+    cap prod env:upload                                      Will upload .env file to server and decrypt
+    cap prod env:upload:diff                                 Will run `diff` command to server's .env versus local .env - decrypted
+    cap prod env:local:encrypt_file                          Will encrypt `cap-secrets-LOCAL.txt` to `ap-secrets.enc.b64`
+    cap prod env:local:decrypt_file                          Will decrypt `ap-secrets.enc.b64` into `cap-secrets-LOCAL.txt`
+    cap prod env:local:secrets                               cat `cap-secrets-LOCAL.txt`
 #### custom related commands:
     cap prod cat:env                                    Run `cat /var/www/*/*/.env`
     cap prod empty_file:check                           Run `la -lah on nginx, fpm, laravel and var/www/*/current/logs/*`

data/lib/capistrano/addon/fm/stages/fm-addon-stage.rb

@@ -0,0 +1 @@
+set :stage, :'fm-addon-stage'

data/lib/capistrano/addon/fm/tasks/env-with-secrets.rake

@@ -7,6 +7,24 @@ namespace "env" do
   set :default_file_to_decrypt, 'cap-secrets.enc.b64'
   set :default_encryption_key_file, 'cap-secrets-encryption-key-LOCAL.txt'
 
+
+  # set .env to server (.env.tmp copied to .env)
+  task "set" do
+    invoke "env:set_remote_env_file"
+    invoke! "env:decrypt_remote_env_tmp_file"
+    on roles(:app) do
+      execute "cd #{shared_path} && cp .env.tmp .env", raise_on_non_zero_exit: false
+    end
+  end
+  # compares server .env with server .env (via .env.tmp)
+  task "set:diff" do
+    invoke "env:set_remote_env_file"
+    invoke! "env:decrypt_remote_env_tmp_file"
+    on roles(:app) do
+      execute "cd #{shared_path} && diff .env .env.tmp", raise_on_non_zero_exit: false
+    end
+  end
+
   # uploads .env to server (.env.tmp copied to .env)
   task "upload" do
     invoke! "env:local:check:files:exist"
@@ -35,6 +53,13 @@ namespace "env" do
       end
     end
   end
+  # set remote env to server (.env.tmp) - does not decrypt
+  task "set_remote_env_file" do
+    on roles(:app) do |host|
+      latest_release_path = "#{shared_path.sub(/shared$/, 'releases')}/#{capture("ls -1 #{shared_path.sub(/shared$/, 'releases')} | sort -r | head -n 1").strip}"
+      execute "cp #{latest_release_path}/#{host.properties.env_file_location} #{shared_path}/.env.tmp"
+    end
+  end
   # decrypt .env file on server (encrypted .env.tmp to decrypted .env.tmp)
   task "decrypt_remote_env_tmp_file" do
     on roles(:app) do
@@ -42,6 +67,7 @@ namespace "env" do
       base64_file = fetch(:file_to_decrypt, fetch(:default_file_to_decrypt))
       encrypted_file = base64_file.gsub('.b64', '')
       decrypted_file_tmp = "cap-secrets-tmp.txt"
+      latest_release_path = "#{shared_path.sub(/shared$/, 'releases')}/#{capture("ls -1 #{shared_path.sub(/shared$/, 'releases')} | sort -r | head -n 1").strip}"
 
       # Read the .env file
       env_file = capture(:cat, "#{shared_path}/.env.tmp")
@@ -50,7 +76,7 @@ namespace "env" do
       encryption_key = File.read(encryption_key_file).strip
 
       # Decode and decrypt cap-secrets.enc.b64 into a temporary file cap-secrets-tmp.txt
-      execute "base64 -d #{release_path}/#{base64_file} > #{shared_path}/#{encrypted_file} && openssl enc -aes-256-cbc -d -pbkdf2 -in #{shared_path}/#{encrypted_file} -out #{shared_path}/#{decrypted_file_tmp} -pass pass:#{encryption_key}"
+      execute "base64 -d #{latest_release_path}/#{base64_file} > #{shared_path}/#{encrypted_file} && openssl enc -aes-256-cbc -d -pbkdf2 -in #{shared_path}/#{encrypted_file} -out #{shared_path}/#{decrypted_file_tmp} -pass pass:#{encryption_key}"
 
       # Read the secrets from the temporary cap-secrets-tmp.txt file
       secrets = {}
@@ -136,7 +162,7 @@ namespace "env" do
       use_local_path = fetch(:local_path, fetch(:default_local_path))
       Dir.chdir(use_local_path) do
         file = fetch(:file_to_encrypt, fetch(:default_file_to_encrypt))
-        puts "Contents of file #{use_local_path}/#{file}:\n\n"
+        puts "Contents of file #{use_local_path}#{file}:\n\n"
         system("cat #{file}")
       end
     end

data/lib/capistrano/addon/fm/version.rb

@@ -3,7 +3,7 @@
 module Capistrano
   module Addon
     module Fm
-      VERSION = "0.1.2"
+      VERSION = "0.1.4"
     end
   end
 end

data/lib/capistrano/addon/fm.rb

@@ -2,6 +2,9 @@
 
 require_relative "fm/version"
 
+load File.expand_path("fm/stages/fm-addon-stage.rb", __dir__)
+# set :stage, :'fm-addon-stage' unless fetch(:stage, nil)
+
 # Load all .rake files from the tasks directory
 Dir.glob(File.expand_path("./fm/tasks/**/*.rake", __dir__)).each { |r| load r }
 
@@ -13,3 +16,35 @@ module Capistrano
     end
   end
 end
+
+namespace 'fm' do
+  task 'version' do
+    run_locally do
+      gem_root = File.expand_path('./', __dir__)
+      Dir.chdir(gem_root) do
+        system('cat fm/version.rb | grep VERSION')
+      end
+    end
+  end
+  task 'readme' do
+    run_locally do
+      gem_root = File.expand_path('../../../', __dir__)
+      Dir.chdir(gem_root) do
+        system('cat readme.md')
+      end
+    end
+  end
+  task 'readme:tasks' do
+    run_locally do
+      gem_root = File.expand_path('../../../', __dir__)
+      Dir.chdir(gem_root) do
+        system("awk '
+  /^## Usage$/ { print; in_section=1; next }
+  /^## Configuration$/ { exit }
+  in_section { print }
+' README.md
+")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-addon-fm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Florin Motoc
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2026-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -38,6 +38,7 @@ files:
 - Rakefile
 - lib/capistrano/addon.rb
 - lib/capistrano/addon/fm.rb
+- lib/capistrano/addon/fm/stages/fm-addon-stage.rb
 - lib/capistrano/addon/fm/tasks/custom.rake
 - lib/capistrano/addon/fm/tasks/env-with-secrets.rake
 - lib/capistrano/addon/fm/tasks/fpm.rake