capistrano-addon-fm 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52453fe086dda55f4fb47b7e69ceb803166c8622b4dad45792ba31d088f2396f
-  data.tar.gz: fba1b31e7d11fd4f26f422bb1d3bb4af40ce722655dc2cdeeeb676868183e5d2
+  metadata.gz: 5701d4dd587e45f260c6d05bded677f6e2885b1ef22f0d7b75f2a8997149c95b
+  data.tar.gz: f19ab3fb1ba5e7b83afcd908e863023b3effcb19e4becb66a4b69a035957396b
 SHA512:
-  metadata.gz: 611af17bbed983069b57dbc7545d2f83f88c55b6ce8cd57803be682d73f67a0aae71abe10b31a448435a03846223675f43c281b12c34c2db15562702b461d8c2
-  data.tar.gz: c665aa995fb140c45b4821160fbc60f36a30ce0e18f9b424ac85f55815ef7603016eff98ad923250190721f2e526d6f37e122cb204c487438277ce691fa7a00e
+  metadata.gz: 2e57f2376477429d2557d52de9c75eacf4bfff991040a41f6c417e1c790ca8cd6243ac89e2130af361f0a10c7bdf5dae26d93bab8446ce02c7356c21b03ab523
+  data.tar.gz: 772dea6e4d0fed85789331725dd40bd8b80bedb14fda966d08711abd7078992a394371fde20d4e5412d46f3251255fd06360a1255d3be7f6672e07bcf6e9f305

data/CHANGELOG.md

@@ -1,9 +1,21 @@
 # Changelog
 All notable changes to this project will be documented in this 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,8 @@ require 'capistrano/addon/fm'
 ## Usage
 
 ### this will add new tasks for `cap` command
+#### addon related commands (no stage needed):
+    cap fm:readme                                       Will output this readme file
 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 +59,11 @@ 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: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

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 namespace "env" do
   # Set default values
   set :default_local_path, './'
@@ -40,6 +42,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")
@@ -48,7 +51,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 = {}
@@ -66,9 +69,17 @@ namespace "env" do
           secrets[$1]
         end
       end
+      decrypted_content = decrypted_lines.join
+
+      # Create a temporary local file with the decrypted content
+      Tempfile.open('.env.tmp') do |tempfile|
+        tempfile.write(decrypted_content)
+        tempfile.write("\n")
+        tempfile.close
 
-      # Write the modified .env file back to the server
-      execute :echo, "'#{decrypted_lines.join}' > #{shared_path}/.env.tmp", verbosity: :DEBUG
+        # Upload the temporary file to the remote server
+        upload! tempfile.path, "#{shared_path}/.env.tmp", verbosity: :DEBUG
+      end
     end
   end
   namespace :local do
@@ -126,7 +137,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.1"
+      VERSION = "0.1.3"
     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,27 @@ module Capistrano
     end
   end
 end
+
+namespace 'fm' do
+  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.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Florin Motoc
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-08-26 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