Class: Clacky::DeployTemplates::RailsDeploy
- Inherits:
-
Object
- Object
- Clacky::DeployTemplates::RailsDeploy
- Defined in:
- lib/clacky/default_skills/deploy/scripts/rails_deploy.rb
Overview
RailsDeploy — three-phase automated deployment to Railway via Clacky platform.
Phase 0: Cloud project binding check (openclacky.yml + workspace_key + API) Phase 1: Subscription / payment check Phase 2: 8-step Railway deployment
Constant Summary collapse
- PAYMENT_POLL_INTERVAL =
seconds between payment status checks
10- PAYMENT_POLL_MAX =
max attempts (180 seconds / 3 minutes total)
18- DB_POLL_INTERVAL =
seconds between service readiness checks
2- DB_POLL_MAX =
max attempts (120 seconds total)
60- DEPLOY_POLL_INTERVAL =
seconds between deploy status checks
5- DEPLOY_POLL_MAX =
max attempts (300 seconds total)
60- DASHBOARD_PATH =
DASHBOARD_BASE_URL is resolved dynamically from ClackyCloudConfig#dashboard_url so it automatically tracks the environment (prod / staging / local).
"/dashboard/openclacky-project"
Class Method Summary collapse
Instance Method Summary collapse
- #build_env_vars(project) ⇒ Object
- #commit_deploy_files ⇒ Object
- #detect_app_port ⇒ Object
- #detect_service_name(env) ⇒ Object
-
#ensure_dockerfile ⇒ Object
———————————————————————– Step 0 sub-helpers ———————————————————————–.
- #ensure_linux_platform ⇒ Object
- #ensure_railway_toml ⇒ Object
- #extract_categorized_config(categorized_config) ⇒ Object
- #fetch_project(cloud_client, api_client, project_id, workspace_key, base_url) ⇒ Object
- #first_deployment?(service_name, env) ⇒ Boolean
-
#format_duration(seconds) ⇒ Object
Detect the app’s HTTP port from project config files.
- #generate_secret_key_base ⇒ Object
- #hard_fail(message) ⇒ Object
-
#load_binding_file ⇒ Object
———————————————————————– Phase 0 helpers ———————————————————————–.
- #load_clacky_cloud_config ⇒ Object
- #open_browser(url) ⇒ Object
- #parse_figaro_production ⇒ Object
-
#platform_already_present?(lock_content, platform) ⇒ Boolean
———————————————————————– Utility helpers ———————————————————————–.
- #pre_deploy_migrate_configured? ⇒ Boolean
- #print_banner ⇒ Object
- #railway_cli_available? ⇒ Boolean
- #railway_env(platform_token) ⇒ Object
-
#read_deploy_task_id ⇒ Object
Read the most recent deploy_task_id from .clacky/openclacky.yml.
-
#run ⇒ Object
———————————————————————– Top-level orchestration ———————————————————————–.
-
#run_create_cloud_project ⇒ Object
Inline cloud project creation — reuses cloud_project_init.sh Only creates the cloud record + writes .clacky/openclacky.yml.
-
#run_payment_flow(project, project_id, api_client) ⇒ Object
———————————————————————– Phase 1 helpers ———————————————————————–.
-
#run_phase0 ⇒ Object
———————————————————————– Phase 0 — Cloud project binding check ———————————————————————–.
-
#run_phase1(project, project_id, api_client) ⇒ Object
———————————————————————– Phase 1 — Subscription check ———————————————————————–.
-
#run_phase2(project, project_id, api_client, started_at: nil) ⇒ Object
———————————————————————– Phase 2 — Railway deployment (8 steps) ———————————————————————–.
- #shell_escape(str) ⇒ Object
- #show_build_logs(service_name, platform_token) ⇒ Object
- #step0_prepare_linux_platform ⇒ Object
-
#step0b_select_region(api_client, project_id) ⇒ Hash
Fetch deployment regions from the API and prompt the user to pick one.
- #step1_create_task(project_id, api_client, region: nil) ⇒ Object
- #step2_railway_link(railway_token, platform_project_id) ⇒ Object
-
#step3_5_create_database(main_service_name, railway_token) ⇒ Object
Step 3.5: Ensure database service exists (create if needed, reuse if exists) Returns { success: true, db_service_name: “…”, status: “existing|created” }.
- #step3_inject_env_vars(service_name, project, platform_token) ⇒ Object
-
#step3b_inject_bucket_vars(service_name, bucket_credentials, bucket_name, platform_token) ⇒ Object
Inject S3-compatible storage bucket credentials as STORAGE_BUCKET_* env vars.
-
#step4_wait_domain_and_bucket(deploy_task_id, api_client) ⇒ Object
Step 4: Wait for domain binding and fetch storage bucket credentials Database is now created in step3_5, so this step only handles domain + bucket.
-
#step5_deploy_and_wait(service_name, project_id, deploy_task_id, api_client, platform_token) ⇒ Object
Step 5: Deploy and wait for completion (blocking) Uses railway up without –detach to show live logs and wait for completion.
- #step6_run_migrations(service_name, platform_token) ⇒ Object
- #step7_finish(deployment_url, project_id, deploy_task_id, deploy_service_id, api_client, started_at: nil) ⇒ Object
-
#timed_gets(seconds) ⇒ Object
Read a line from stdin with a timeout.
- #write_binding_file(project_id, project_name) ⇒ Object
- #write_categorized_config(categorized_config) ⇒ Object
-
#write_deploy_task_id(deploy_task_id) ⇒ Object
Persist the most recent deploy_task_id into .clacky/openclacky.yml.
Class Method Details
.execute ⇒ Object
50 51 52 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 50 def self.execute new.run end |
Instance Method Details
#build_env_vars(project) ⇒ Object
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1199 def build_env_vars(project) vars = { "RAILS_ENV" => "production", "RAILS_SERVE_STATIC_FILES" => "true", "RAILS_LOG_TO_STDOUT" => "true", "RAILWAY_RUN_UID" => "0" } # Generate SECRET_KEY_BASE secret = generate_secret_key_base vars["SECRET_KEY_BASE"] = secret if secret # Figaro: parse config/application.yml (ERB-rendered). # This already contains the CLACKY_* integration vars written by /new, # so we don't need to inject categorized_config separately. figaro_vars = parse_figaro_production if figaro_vars.any? vars.merge!(figaro_vars) else # Fallback: inject categorized_config directly if no application.yml vars.merge!(extract_categorized_config(project["categorized_config"])) end # Filter out empty values - Railway CLI doesn't accept them vars.reject { |_k, v| v.to_s.strip.empty? } end |
#commit_deploy_files ⇒ Object
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 694 def commit_deploy_files # Collect files that are git-tracked and have uncommitted changes files_to_commit = %w[Dockerfile railway.toml Gemfile.lock].select do |f| next false unless File.exist?(f) # Check if tracked by git _, _, tracked = Open3.capture3("git ls-files --error-unmatch #{f}") next false unless tracked.success? # Check if modified or new (untracked-but-staged) diff_out, _, _ = Open3.capture3("git status --porcelain #{f}") !diff_out.strip.empty? end if files_to_commit.empty? puts " ℹ️ No deploy files changed — skipping commit" return { success: true } end print " 📝 Committing deploy files (#{files_to_commit.join(", ")})..." _out, err, status = Open3.capture3( "git add #{files_to_commit.map { |f| "'#{f}'" }.join(" ")} && " \ "git commit -m 'chore: prepare project for Railway deployment'" ) unless status.success? puts " ❌" return hard_fail("git commit failed:\n#{err}") end puts " ✅" { success: true } end |
#detect_app_port ⇒ Object
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1128 def detect_app_port # config/puma.rb: port ENV.fetch("PORT", 3000) or port 3000 if File.exist?("config/puma.rb") content = File.read("config/puma.rb") if content =~ /port\s+ENV\.fetch\(["']PORT["']\s*,\s*(\d+)\s*\)/ return $1.to_i end if content =~ /port\s+(\d+)/ return $1.to_i end end # Procfile: web: bundle exec puma -p 3000 or -p $PORT if File.exist?("Procfile") content = File.read("Procfile") if content =~ /web:.*-p\s+(\d+)/ return $1.to_i end end 3000 end |
#detect_service_name(env) ⇒ Object
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1159 def detect_service_name(env) # 1. Try railway.toml [service] name field toml = "railway.toml" if File.exist?(toml) content = File.read(toml) m = content.match(/\[service\][^\[]*name\s*=\s*["']?([^"'\n]+)["']?/m) return m[1].strip if m end # 2. Use railway status --json to find the linked service out, _err, status = Open3.capture3(env, "railway status --json") if status.success? begin info = JSON.parse(out) # Railway v4 status JSON uses edges/node format: # { "services": { "edges": [ { "node": { "id": "...", "name": "..." } } ] } } # Older format was: { "services": [ { "name": "..." } ] } raw_svcs = info["services"] svcs = if raw_svcs.is_a?(Hash) && raw_svcs["edges"] raw_svcs["edges"].map { |e| e["node"] }.compact elsif raw_svcs.is_a?(Array) raw_svcs else [] end svc = svcs.find do |s| name = s["name"].to_s.downcase !%w[postgres postgresql mysql redis].any? { |db| name.include?(db) } end return svc["name"] if svc rescue JSON::ParserError # fall through end end # 3. Fallback to directory name File.basename(Dir.pwd) end |
#ensure_dockerfile ⇒ Object
Step 0 sub-helpers
641 642 643 644 645 646 647 648 649 650 651 652 653 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 641 def ensure_dockerfile if File.exist?("Dockerfile") puts " ✅ Dockerfile already exists" return { success: true } end hard_fail( "Dockerfile not found.\n" \ " A Dockerfile is required for Railway deployment.\n" \ " The rails-template-7x-starter includes one by default — " \ "make sure you haven't accidentally deleted it." ) end |
#ensure_linux_platform ⇒ Object
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 671 def ensure_linux_platform # Check 1: Gemfile.lock must exist unless File.exist?("Gemfile.lock") return hard_fail( "Gemfile.lock not found.\n" \ " Run `bundle install` first to generate it." ) end # Check 2: x86_64-linux must already be present lock_content = File.read("Gemfile.lock") if platform_already_present?(lock_content, "x86_64-linux") puts " ✅ x86_64-linux platform already present in Gemfile.lock" return { success: true } end hard_fail( "x86_64-linux platform is missing from Gemfile.lock.\n" \ " Run: bundle lock --add-platform x86_64-linux\n" \ " Then commit the updated Gemfile.lock and retry." ) end |
#ensure_railway_toml ⇒ Object
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 655 def ensure_railway_toml toml_path = "railway.toml" if File.exist?(toml_path) puts " ✅ railway.toml already exists" return { success: true } end hard_fail( "railway.toml not found.\n" \ " A railway.toml is required for Railway deployment.\n" \ " The rails-template-7x-starter includes one by default — " \ "make sure you haven't accidentally deleted it." ) end |
#extract_categorized_config(categorized_config) ⇒ Object
1280 1281 1282 1283 1284 1285 1286 1287 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1280 def extract_categorized_config(categorized_config) return {} unless categorized_config.is_a?(Hash) categorized_config.each_with_object({}) do |(_category, vars), h| next unless vars.is_a?(Hash) vars.each { |k, v| h[k.to_s] = v.to_s } end end |
#fetch_project(cloud_client, api_client, project_id, workspace_key, base_url) ⇒ Object
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 338 def fetch_project(cloud_client, api_client, project_id, workspace_key, base_url) result = cloud_client.get_project(project_id) # 404 or project missing → recreate cloud project if !result[:success] && result[:error].to_s.include?("404") puts "⚠️ Cloud project not found (404). Creating a new one..." return run_create_cloud_project end unless result[:success] return hard_fail("Unable to verify project: #{result[:error]}\n" \ " Check your network connection and workspace key.") end { success: true, project: result[:project] } end |
#first_deployment?(service_name, env) ⇒ Boolean
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1296 def first_deployment?(service_name, env) require "timeout" run_with_timeout = lambda do |cmd, limit| out = nil status = nil Timeout.timeout(limit) do out, _err, status = Open3.capture3(env, cmd) end [out, status] rescue Timeout::Error warn " ⚠️ Command timed out (>#{limit}s): #{cmd.split.first(4).join(" ")}..." [nil, nil] rescue => e warn " ⚠️ Command error: #{e.}" [nil, nil] end # Check 1: can we connect to the DB at all? (60s timeout) check1_cmd = "railway run --service #{shell_escape(service_name)} " \ "bundle exec rails runner \"ActiveRecord::Base.connection; puts 'connected'\"" _out1, status1 = run_with_timeout.call(check1_cmd, 60) return true if status1.nil? || !status1.success? # Check 2: any migrations recorded? (60s timeout) check2_cmd = "railway run --service #{shell_escape(service_name)} " \ "bundle exec rails db:migrate:status 2>&1" out2, _status2 = run_with_timeout.call(check2_cmd, 60) return false if out2.nil? # If no schema_migrations entries exist, output mentions "up" lines !out2.match?(/^\s*(up|down)\s+\d{14}/) rescue false end |
#format_duration(seconds) ⇒ Object
Detect the app’s HTTP port from project config files. Checks (in order): config/puma.rb → Procfile → defaults to 3000. Format seconds into a human-readable duration string (e.g. “2m 34s”, “45s”).
1121 1122 1123 1124 1125 1126 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1121 private def format_duration(seconds) return "#{seconds}s" if seconds < 60 m = seconds / 60 s = seconds % 60 s > 0 ? "#{m}m #{s}s" : "#{m}m" end |
#generate_secret_key_base ⇒ Object
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1226 def generate_secret_key_base # Use a 30s timeout so a slow Rails boot doesn't silently hang the deploy. # Open3.capture3 blocks indefinitely; Timeout::Error is raised if it exceeds the limit. require "timeout" begin out = nil Timeout.timeout(30) do out, _err, status = Open3.capture3("bundle exec rails secret") return out.strip if status.success? && !out.strip.empty? end rescue Timeout::Error warn " ⚠️ `bundle exec rails secret` timed out (>30s) — using SecureRandom fallback" rescue => e warn " ⚠️ `bundle exec rails secret` failed (#{e.}) — using SecureRandom fallback" end # Fallback: generate a cryptographically secure key using SecureRandom require "securerandom" SecureRandom.hex(64) end |
#hard_fail(message) ⇒ Object
1359 1360 1361 1362 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1359 def hard_fail() puts "\n❌ #{}" { success: false, error: } end |
#load_binding_file ⇒ Object
Phase 0 helpers
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 299 def load_binding_file binding_file = ".clacky/openclacky.yml" unless File.exist?(binding_file) return run_create_cloud_project end data = YAML.safe_load(File.read(binding_file)) || {} project_id = data["project_id"].to_s.strip if project_id.empty? return hard_fail( ".clacky/openclacky.yml exists but project_id is missing.\n" \ " The file may be corrupted. Delete it and run /new to reinitialize." ) end { success: true, project_id: project_id } rescue => e hard_fail("Failed to read .clacky/openclacky.yml: #{e.}") end |
#load_clacky_cloud_config ⇒ Object
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 321 def load_clacky_cloud_config cfg = ClackyCloudConfig.load if cfg.workspace_key.nil? || cfg.workspace_key.empty? return hard_fail( "No Clacky workspace key configured (~/.clacky/clacky_cloud.yml).\n" \ " Obtain a workspace key offline, then run:\n" \ " clacky config set workspace_key <clacky_ak_xxx>" ) end # Store dashboard base so payment_flow and step8 use the right environment URL @dashboard_base_url = "#{cfg.dashboard_url}#{DASHBOARD_PATH}" { success: true, workspace_key: cfg.workspace_key, base_url: cfg.base_url } end |
#open_browser(url) ⇒ Object
1347 1348 1349 1350 1351 1352 1353 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1347 def open_browser(url) case RbConfig::CONFIG["host_os"] when /darwin/ then system("open #{shell_escape(url)}") when /linux/ then system("xdg-open #{shell_escape(url)}") when /mingw|mswin/ then system("start #{shell_escape(url)}") end end |
#parse_figaro_production ⇒ Object
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1246 def parse_figaro_production app_yml = "config/application.yml" return {} unless File.exist?(app_yml) require "erb" require "timeout" raw = File.read(app_yml) # ERB.new(raw).result can hang if it calls ENV.fetch on a missing key # (raises KeyError before YAML parse) — wrap in a 10s timeout. rendered = begin Timeout.timeout(10) { ERB.new(raw).result } rescue Timeout::Error warn " ⚠️ ERB render of config/application.yml timed out (>10s) — skipping figaro vars" return {} rescue => e warn " ⚠️ ERB render error in config/application.yml: #{e.} — skipping figaro vars" return {} end data = YAML.safe_load(rendered) || {} # Figaro stores all vars at the top level (no "production:" block). # Skip blank values — those are placeholders to be filled by the user. data.each_with_object({}) do |(k, v), h| next if v.to_s.strip.empty? h[k.to_s] = v.to_s end rescue => e warn "[deploy] parse_figaro_production error: #{e.}" {} end |
#platform_already_present?(lock_content, platform) ⇒ Boolean
Utility helpers
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1100 def platform_already_present?(lock_content, platform) # Gemfile.lock PLATFORMS section looks like: # PLATFORMS # arm64-darwin-23 # x86_64-linux in_platforms = false lock_content.each_line do |line| if line.strip == "PLATFORMS" in_platforms = true next end # A non-indented line signals the end of the PLATFORMS block break if in_platforms && !line.start_with?(" ") return true if in_platforms && line.strip == platform end false end |
#pre_deploy_migrate_configured? ⇒ Boolean
1289 1290 1291 1292 1293 1294 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1289 def pre_deploy_migrate_configured? toml_path = "railway.toml" return false unless File.exist?(toml_path) content = File.read(toml_path) content.include?("preDeployCommand") && content.include?("db:migrate") end |
#print_banner ⇒ Object
1364 1365 1366 1367 1368 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1364 def puts "\n" + "=" * 60 puts "🚂 Clacky Rails Deploy" puts "=" * 60 end |
#railway_cli_available? ⇒ Boolean
1151 1152 1153 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1151 def railway_cli_available? system("which railway > /dev/null 2>&1") end |
#railway_env(platform_token) ⇒ Object
1155 1156 1157 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1155 def railway_env(platform_token) ENV.to_h.merge("RAILWAY_TOKEN" => platform_token) end |
#read_deploy_task_id ⇒ Object
Read the most recent deploy_task_id from .clacky/openclacky.yml. Returns nil if the file doesn’t exist or the key is absent.
438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 438 def read_deploy_task_id binding_file = ".clacky/openclacky.yml" return nil unless File.exist?(binding_file) data = YAML.safe_load(File.read(binding_file)) || {} id = data["deploy_task_id"].to_s.strip id.empty? ? nil : id rescue => e warn " ⚠️ Could not read deploy_task_id from #{binding_file}: #{e.}" nil end |
#run ⇒ Object
Top-level orchestration
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 83 def run result = nil started_at = Time.now begin puts "[DEPLOY] Started at #{started_at.strftime("%Y-%m-%d %H:%M:%S")}" # Phase 0: binding + workspace key + project details set_phase("Phase 0: verifying cloud project binding") phase0 = run_phase0 unless phase0[:success] result = phase0 return result end # @dashboard_base_url is set by load_clacky_cloud_config during Phase 0 project = phase0[:project] project_id = phase0[:project_id] api_client = phase0[:api_client] # Phase 1: subscription / payment set_phase("Phase 1: checking subscription") phase1 = run_phase1(project, project_id, api_client) unless phase1[:success] result = phase1 return result end # Phase 2: deploy set_phase("Phase 2: Railway deployment") result = run_phase2(project, project_id, api_client, started_at: started_at) result rescue => e result = { success: false, error: "Unexpected error: #{e.}" } puts "❌ Unexpected error: #{e.}" puts e.backtrace.first(10).join("\n") result ensure finish_phase # print timing for the last phase result ||= { success: false, error: "Unknown error" } elapsed_total = (Time.now - started_at).round duration_str = format_duration(elapsed_total) if result[:success] puts "\n[DEPLOY] RESULT: SUCCESS (#{duration_str})" else puts "\n[DEPLOY] RESULT: FAILED (#{duration_str}) — #{result[:error]}" end end end |
#run_create_cloud_project ⇒ Object
Inline cloud project creation — reuses cloud_project_init.sh Only creates the cloud record + writes .clacky/openclacky.yml. Does NOT clone template, run bin/setup, or start a server.
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 358 def run_create_cloud_project puts "\n📦 Initializing cloud project binding...\n" script = File.( "../../new/scripts/cloud_project_init.sh", DEPLOY_SCRIPT_DIR ) unless File.exist?(script) return hard_fail("cloud_project_init.sh not found at: #{script}") end project_name = File.basename(Dir.pwd) env = { "GEM_LIB_DIR" => GEM_LIB_DIR, "PROJECT_NAME" => project_name } output, status = Open3.capture2(env, "bash", script, project_name) unless status.success? return hard_fail("Cloud project creation failed (exit #{status.exitstatus})") end result = JSON.parse(output.strip) unless result["success"] return hard_fail("Cloud project creation failed: #{result["error"]}") end project_id = result["project_id"] project_name = result["project_name"] # Write .clacky/openclacky.yml write_binding_file(project_id, project_name) # Write integration env vars if categorized_config present write_categorized_config(result["categorized_config"]) if result["categorized_config"] puts "✅ Cloud project created: #{project_name} (#{project_id})" puts " Restarting Phase 0 with new project..." # Re-enter Phase 0 with new binding load_binding_file rescue JSON::ParserError => e hard_fail("Cloud project init returned invalid JSON: #{e.}\n Raw: #{output.to_s[0, 200]}") rescue => e hard_fail("Cloud project creation error: #{e.}") end |
#run_payment_flow(project, project_id, api_client) ⇒ Object
Phase 1 helpers
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 483 def run_payment_flow(project, project_id, api_client) project_name = project["name"] puts "\n❌ Deployment blocked: Clacky subscription required." puts " Project : #{project_name} (#{project_id})" puts " Status : #{project.dig("subscription", "status") || "none"}" puts "\n A subscription is needed before deployment can proceed." payment_url = "#{@dashboard_base_url}/#{project_id}" open_browser(payment_url) puts "\n🌐 Payment page opened:" puts " #{payment_url}" puts "\n⏳ Waiting for payment confirmation (max 3 minutes)...\n" # Poll payment status every PAYMENT_POLL_INTERVAL seconds. total_seconds = PAYMENT_POLL_INTERVAL * PAYMENT_POLL_MAX # 180s PAYMENT_POLL_MAX.times do |i| elapsed = i * PAYMENT_POLL_INTERVAL result = api_client.payment_status(project_id: project_id) if result[:success] && result[:is_paid] puts " ✅ Payment confirmed (#{elapsed}s)" return { success: true } end remaining = total_seconds - elapsed puts " ⏳ [#{elapsed}s] Waiting for payment... (#{remaining}s remaining)" sleep PAYMENT_POLL_INTERVAL unless i == PAYMENT_POLL_MAX - 1 end # Timeout — exit with clear guidance puts "" hard_fail( "Payment not confirmed within 3 minutes.\n" \ " Once payment is complete, re-run: /deploy" ) end |
#run_phase0 ⇒ Object
Phase 0 — Cloud project binding check
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 145 def run_phase0 puts "\n[Phase 0] Verifying cloud project binding...\n" # 0.1 Read .clacky/openclacky.yml print " 📄 Reading project binding file..." binding_result = load_binding_file return binding_result unless binding_result[:success] project_id = binding_result[:project_id] puts " ✅ (#{project_id})" # 0.2 Load platform config (workspace_key) print " 🔑 Loading platform config..." cfg_result = load_clacky_cloud_config return cfg_result unless cfg_result[:success] workspace_key = cfg_result[:workspace_key] base_url = cfg_result[:base_url] puts " ✅" # 0.3 Fetch project details from API print " 🌐 Verifying project with Clacky API..." api_client = DeployApiClient.new(workspace_key, base_url: base_url) cloud_client = CloudProjectClient.new(workspace_key, base_url: base_url) project_result = fetch_project(cloud_client, api_client, project_id, workspace_key, base_url) return project_result unless project_result[:success] puts " ✅" puts "✅ Cloud project verified: #{project_result[:project]["name"]} (#{project_id})" { success: true, project: project_result[:project], project_id: project_id, api_client: api_client, cloud_client: cloud_client } end |
#run_phase1(project, project_id, api_client) ⇒ Object
Phase 1 — Subscription check
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 187 def run_phase1(project, project_id, api_client) puts "\n[Phase 1] Checking subscription status...\n" subscription = project["subscription"] status = subscription&.dig("status").to_s.upcase case status when "PAID" puts "✅ Subscription active (PAID)" { success: true } when "FREEZE" puts "⚠️ Subscription expiring soon (FREEZE). Continuing deployment..." { success: true } when "SUSPENDED" hard_fail("Subscription is SUSPENDED. Please contact support.") else # nil / "OFF" / "CANCELLED" → payment required run_payment_flow(project, project_id, api_client) end end |
#run_phase2(project, project_id, api_client, started_at: nil) ⇒ Object
Phase 2 — Railway deployment (8 steps)
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 212 def run_phase2(project, project_id, api_client, started_at: nil) puts "\n[Phase 2] Starting Railway deployment...\n" # Pre-check: railway CLI installed? unless railway_cli_available? return hard_fail( "Railway CLI not found.\n" \ " Install: npm install -g @railway/cli\n" \ " Then retry deployment." ) end # Step 0: ensure Gemfile.lock includes x86_64-linux platform set_phase("Step 0: preparing project for Railway") step0 = step0_prepare_linux_platform return step0 unless step0[:success] # Step 0b: let user choose a deployment region set_phase("Step 0b: selecting deployment region") region_step = step0b_select_region(api_client, project_id) return region_step unless region_step[:success] selected_region = region_step[:region] # Step 1: create deploy task (pass selected region if any) set_phase("Step 1: creating deploy task") task = step1_create_task(project_id, api_client, region: selected_region) return task unless task[:success] platform_token = task[:platform_token] # platform_token is used for all Railway CLI commands (link, variables, up, run, etc.) # as well as Clacky internal API calls. railway_token = platform_token platform_project_id = task[:platform_project_id] deploy_task_id = task[:deploy_task_id] deploy_service_id = task[:deploy_service_id] # Step 2: railway link set_phase("Step 2: linking Railway project") link = step2_railway_link(railway_token, platform_project_id) return link unless link[:success] main_service_name = link[:service_name] # Step 3: inject env vars set_phase("Step 3: injecting env vars") env_result = step3_inject_env_vars(main_service_name, project, railway_token) return env_result unless env_result[:success] # Step 3.5: ensure database exists (create only on first deploy, reuse on updates) set_phase("Step 3.5: ensuring database service") db_result = step3_5_create_database(main_service_name, railway_token) return db_result unless db_result[:success] # Step 4: wait for domain binding and fetch storage bucket credentials set_phase("Step 4: waiting for domain binding") step4 = step4_wait_domain_and_bucket(deploy_task_id, api_client) return step4 unless step4[:success] domain_name = step4[:domain_name] bucket_credentials = step4[:bucket_credentials] bucket_name = step4[:bucket_name] # Inject storage bucket credentials if available (separate from main env vars # because we need to call services API first to get them) if bucket_credentials step3b_inject_bucket_vars(main_service_name, bucket_credentials, bucket_name, railway_token) end # Step 5: trigger build and wait for completion (blocking) set_phase("Step 5: building and deploying") build = step5_deploy_and_wait(main_service_name, project_id, deploy_task_id, api_client, railway_token) return build unless build[:success] deployment_url = build[:url] # Step 6: database migrations set_phase("Step 6: running database migrations") step6_run_migrations(main_service_name, railway_token) # Step 7: health check + notify success set_phase("Step 7: health check + finalising") step7_finish(deployment_url, project_id, deploy_task_id, deploy_service_id, api_client, started_at: started_at) end |
#shell_escape(str) ⇒ Object
1355 1356 1357 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1355 def shell_escape(str) "'#{str.to_s.gsub("'", "'\\\\''")}'" end |
#show_build_logs(service_name, platform_token) ⇒ Object
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1333 def show_build_logs(service_name, platform_token) puts "\n📋 Last build log lines:" puts "-" * 40 env = railway_env(platform_token) cmd = "railway logs --build --lines 30 --service #{shell_escape(service_name)}" out, err, _status = Open3.capture3(env, cmd) output = out.empty? ? err : out output.each_line { |line| puts " #{line.chomp}" } puts "-" * 40 end |
#step0_prepare_linux_platform ⇒ Object
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 614 def step0_prepare_linux_platform puts "\n[Step 0] Preparing project for Railway deployment..." # 0-A: Ensure Dockerfile exists with optimal layer-caching structure dockerfile_result = ensure_dockerfile return dockerfile_result unless dockerfile_result[:success] # 0-B: Ensure railway.toml exists with DOCKERFILE builder + preDeployCommand toml_result = ensure_railway_toml return toml_result unless toml_result[:success] # 0-C: Ensure Gemfile.lock includes x86_64-linux platform gemfile_result = ensure_linux_platform return gemfile_result unless gemfile_result[:success] # 0-D: Commit any generated/modified files so Railway picks them up commit_result = commit_deploy_files return commit_result unless commit_result[:success] puts "✅ Step 0 complete — project is Railway-ready" { success: true } end |
#step0b_select_region(api_client, project_id) ⇒ Hash
Fetch deployment regions from the API and prompt the user to pick one. Falls back gracefully: if API fails or returns an empty list, asks the user to input a region manually; entering nothing skips region selection entirely.
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 534 def step0b_select_region(api_client, project_id) puts "\n[Step 0b] Selecting deployment region..." result = api_client.regions(project_id: project_id) regions = if result[:success] && result[:regions].any? result[:regions] else warn " ⚠️ Could not fetch region list: #{result[:error]}" unless result[:success] [] end # Non-interactive mode: skip stdin prompts entirely when not running in a real TTY # (e.g. called from agent subshell). This prevents indefinite blocking on $stdin.gets. unless $stdin.isatty if regions.any? selected = regions.first region = selected["region"] # Always use region field (ID like "us-west2") puts " ℹ️ Non-interactive mode — auto-selecting first region: #{region}" return { success: true, region: region } else puts " ℹ️ Non-interactive mode — using platform default region" return { success: true, region: nil } end end if regions.empty? # Manual fallback with 20s timeout to prevent indefinite blocking print " Enter a region slug (leave blank to skip, auto-skip in 20s): " $stdout.flush input = timed_gets(20).to_s.strip region = input.empty? ? nil : input puts region ? " ✅ Region set to: #{region}" : " ℹ️ No region specified, using platform default" return { success: true, region: region } end # Display numbered list puts " Available regions:" regions.each_with_index do |r, idx| region_id = r["region"] puts " #{idx + 1}) #{region_id}" end # Prompt for selection with 20s timeout to prevent indefinite blocking print " Enter region number (1-#{regions.size}, or press Enter/wait 20s for default): " $stdout.flush input = timed_gets(20).to_s.strip if input.empty? puts " ℹ️ No region selected, using platform default" return { success: true, region: nil } end choice = input.to_i unless choice.between?(1, regions.size) puts " ⚠️ Invalid selection '#{input}', using platform default" return { success: true, region: nil } end selected = regions[choice - 1] region = selected["region"] puts " ✅ Region selected: #{region}" { success: true, region: region } rescue Interrupt puts "\n ℹ️ Region selection cancelled, using platform default" { success: true, region: nil } end |
#step1_create_task(project_id, api_client, region: nil) ⇒ Object
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 726 def step1_create_task(project_id, api_client, region: nil) puts "\n[Step 1] Creating deploy task..." result = api_client.create_task(project_id: project_id, region: region) unless result[:success] return hard_fail("Failed to create deploy task: #{result[:error]}") end # Persist deploy_task_id to .clacky/openclacky.yml so other tools can # query the most recent deployment without needing to call the API. write_deploy_task_id(result[:deploy_task_id]) puts "✅ Deploy task created: #{result[:deploy_task_id]}" result end |
#step2_railway_link(railway_token, platform_project_id) ⇒ Object
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 742 def step2_railway_link(railway_token, platform_project_id) puts "\n[Step 2] Linking Railway project..." # Write .railway/config.json directly instead of running `railway link`. # `railway link` requires an account-level token (RAILWAY_API_TOKEN) to list # workspaces/projects, but we only have a Project Token (RAILWAY_TOKEN). # Writing the config file is exactly what `railway link` does internally, and # all subsequent CLI commands (up, variables, run, logs) work fine with a # Project Token once the project binding is in place. print " 📝 Writing .railway/config.json..." begin FileUtils.mkdir_p(".railway") config = { "projectId" => platform_project_id, "environmentName" => "production" } File.write(".railway/config.json", JSON.generate(config)) puts " ✅" rescue => e puts " ❌" return hard_fail("Failed to write .railway/config.json: #{e.}") end # Detect main service name using RAILWAY_TOKEN (Project Token supports `railway status`) env = railway_env(railway_token) print " 🔍 Detecting service name..." svc_name = detect_service_name(env) puts " ✅ #{svc_name}" puts "✅ Linked to Railway project. Main service: #{svc_name}" { success: true, service_name: svc_name, railway_token: railway_token } end |
#step3_5_create_database(main_service_name, railway_token) ⇒ Object
Step 3.5: Ensure database service exists (create if needed, reuse if exists) Returns { success: true, db_service_name: “…”, status: “existing|created” }
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 801 def step3_5_create_database(main_service_name, railway_token) puts "\n[Step 3.5] Ensuring PostgreSQL database service..." result = DeployTools::CreateDatabaseService.execute( platform_token: railway_token ) unless result[:success] puts " ❌" return hard_fail("Failed to ensure database: #{result[:error]}") end db_service_name = result[:service_name] database_url = result[:database_url] status = result[:status] # "existing" or "created" if status == "existing" puts " ♻️ Reusing existing database: #{db_service_name}" puts " ℹ️ DATABASE_URL is automatically shared by Railway" elsif status == "created" puts " ✅ Created new database: #{db_service_name}" # Only inject DATABASE_URL for newly created databases print " 💉 Injecting DATABASE_URL into #{main_service_name}..." inject_result = DeployTools::SetDeployVariables.execute( service_name: main_service_name, variables: { "DATABASE_URL" => database_url }, platform_token: railway_token, raw_value: true ) unless inject_result[:success] puts " ❌" return hard_fail("Failed to inject DATABASE_URL: #{inject_result[:errors].inspect}") end puts " ✅" end puts "✅ Database ready: #{db_service_name} (#{status})" { success: true, db_service_name: db_service_name, database_url: database_url, status: status } rescue => e puts " ❌" hard_fail("Unexpected error in step3_5: #{e.}\n#{e.backtrace.first(5).join("\n")}") end |
#step3_inject_env_vars(service_name, project, platform_token) ⇒ Object
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 775 def step3_inject_env_vars(service_name, project, platform_token) puts "\n[Step 3] Injecting environment variables..." print " ⚙️ Building env vars (generating SECRET_KEY_BASE)..." vars = build_env_vars(project) puts " ✅ (#{vars.size} vars)" print " 📤 Pushing env vars to Railway..." result = DeployTools::SetDeployVariables.execute( service_name: service_name, variables: vars, platform_token: platform_token ) unless result[:success] puts " ❌" return hard_fail("Failed to set environment variables: #{result[:errors].inspect}") end puts " ✅" puts "✅ Set #{result[:set_variables].length} environment variable(s)" { success: true } end |
#step3b_inject_bucket_vars(service_name, bucket_credentials, bucket_name, platform_token) ⇒ Object
Inject S3-compatible storage bucket credentials as STORAGE_BUCKET_* env vars. Called after step4 because bucket credentials come from the services API response. The bucket_credentials hash comes from platform_bucket_credentials in the API.
Maps API fields → Railway env vars:
endpoint → STORAGE_BUCKET_ENDPOINT
accessKeyId → STORAGE_BUCKET_ACCESS_KEY_ID
secretAccessKey → STORAGE_BUCKET_SECRET_ACCESS_KEY
region → STORAGE_BUCKET_REGION + AWS_REGION
bucketName → STORAGE_BUCKET_NAME
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 857 def step3b_inject_bucket_vars(service_name, bucket_credentials, bucket_name, platform_token) return unless bucket_credentials.is_a?(Hash) name = bucket_name.to_s.empty? ? bucket_credentials["bucketName"].to_s : bucket_name vars = {} vars["STORAGE_BUCKET_ENDPOINT"] = bucket_credentials["endpoint"].to_s unless bucket_credentials["endpoint"].to_s.empty? vars["STORAGE_BUCKET_ACCESS_KEY_ID"] = bucket_credentials["accessKeyId"].to_s unless bucket_credentials["accessKeyId"].to_s.empty? vars["STORAGE_BUCKET_SECRET_ACCESS_KEY"] = bucket_credentials["secretAccessKey"].to_s unless bucket_credentials["secretAccessKey"].to_s.empty? vars["STORAGE_BUCKET_NAME"] = name unless name.empty? region = bucket_credentials["region"].to_s region = "auto" if region.empty? vars["STORAGE_BUCKET_REGION"] = region vars["AWS_REGION"] = region return if vars.empty? puts "\n[Step 3b] Injecting storage bucket credentials (#{vars.size} vars)..." result = DeployTools::SetDeployVariables.execute( service_name: service_name, variables: vars, platform_token: platform_token ) if result[:success] puts "✅ Storage bucket vars injected (STORAGE_BUCKET_*, AWS_REGION)" else puts "⚠️ Storage bucket vars partially failed: #{result[:errors].inspect}" end end |
#step4_wait_domain_and_bucket(deploy_task_id, api_client) ⇒ Object
Step 4: Wait for domain binding and fetch storage bucket credentials Database is now created in step3_5, so this step only handles domain + bucket
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 891 def step4_wait_domain_and_bucket(deploy_task_id, api_client) puts "\n[Step 4] Waiting for domain binding..." domain_name = nil bucket_credentials = nil bucket_name = nil elapsed = 0 # Poll for domain and bucket credentials puts " ⏳ Waiting for domain assignment (max #{DB_POLL_MAX * DB_POLL_INTERVAL}s)..." DB_POLL_MAX.times do |i| result = api_client.services(deploy_task_id: deploy_task_id) if result[:success] # Capture bucket credentials on first available result bucket_credentials ||= result[:bucket_credentials] bucket_name ||= result[:bucket_name] # Capture domain once available if domain_name.nil? && !result[:domain_name].to_s.empty? domain_name = result[:domain_name] puts " ✅ Domain assigned: #{domain_name} (#{elapsed}s)" break # Domain is all we need now end else puts " ⚠️ Domain poll failed: #{result[:error]} (attempt #{i + 1}/#{DB_POLL_MAX})" end # Sleep before next iteration (skip sleep on last attempt) unless i == DB_POLL_MAX - 1 sleep DB_POLL_INTERVAL elapsed += DB_POLL_INTERVAL puts " ⏳ [#{elapsed}s] Waiting for domain... (attempt #{i + 2}/#{DB_POLL_MAX})" end end # Always call bind_domain — services API only pre-allocates the name, # actual Railway-side binding requires an explicit bind_domain call. print " 🌐 Binding domain via API..." bind = api_client.bind_domain(deploy_task_id: deploy_task_id) if bind[:success] domain_name = bind[:domain] if bind[:domain] && !bind[:domain].to_s.empty? puts " ✅ #{domain_name}" else puts " ⚠️ bind_domain failed: #{bind[:error]}" puts " ℹ️ Using pre-allocated domain: #{domain_name}" if domain_name end # Persist domain to .clacky/deploy.yml for future reference if domain_name deploy_config_path = ".clacky/deploy.yml" existing = File.exist?(deploy_config_path) ? YAML.load_file(deploy_config_path) || {} : {} updated = existing.merge("domain" => domain_name, "deployed_at" => Time.now.strftime("%Y-%m-%d %H:%M:%S")) FileUtils.mkdir_p(".clacky") File.write(deploy_config_path, YAML.dump(updated)) puts " 💾 Domain saved to #{deploy_config_path}" end puts "✅ Step 4 complete. Domain: #{domain_name || "(not available yet)"}" { success: true, domain_name: domain_name, bucket_credentials: bucket_credentials, bucket_name: bucket_name } end |
#step5_deploy_and_wait(service_name, project_id, deploy_task_id, api_client, platform_token) ⇒ Object
Step 5: Deploy and wait for completion (blocking) Uses railway up without –detach to show live logs and wait for completion
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 961 def step5_deploy_and_wait(service_name, project_id, deploy_task_id, api_client, platform_token) puts "\n[Step 5] Building and deploying..." # Notify backend that we're starting deployment api_client.notify(project_id: project_id, deploy_task_id: deploy_task_id, status: "deploying") result = DeployTools::ExecuteDeployment.execute( service_name: service_name, platform_token: platform_token ) unless result[:success] api_client.notify( project_id: project_id, deploy_task_id: deploy_task_id, status: "failed", message: result[:error] ) return hard_fail("Deployment failed: #{result[:error]}") end puts "✅ Build and deployment complete" # Don't notify success yet - wait until after migrations { success: true, url: result[:url] } rescue => e api_client.notify( project_id: project_id, deploy_task_id: deploy_task_id, status: "failed", message: "Unexpected error: #{e.}" ) hard_fail("Unexpected error in step5: #{e.}\n#{e.backtrace.first(5).join("\n")}") end |
#step6_run_migrations(service_name, platform_token) ⇒ Object
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 997 def step6_run_migrations(service_name, platform_token) puts "\n[Step 6] Running database migrations..." env = railway_env(platform_token) # If railway.toml has preDeployCommand = "bundle exec rails db:migrate", # migrations already ran inside the deploy container — skip redundant railway run. if pre_deploy_migrate_configured? puts " ⚡ preDeployCommand detected — db:migrate ran automatically during deploy" puts " ✅ Skipping redundant migration step (~30s saved)" else # No preDeployCommand — run migrations explicitly print " 🗄️ Running db:migrate (this may take ~30s)..." migrate_cmd = "railway run --service #{shell_escape(service_name)} bundle exec rails db:migrate" out, err, status = Open3.capture3(env, migrate_cmd) if status.success? puts " ✅" puts out unless out.strip.empty? else puts " ⚠️" puts "⚠️ Migration warning (continuing): #{err}" end end # Seed detection: only on first deployment (no preDeployCommand equivalent for seeds) print " 🔍 Checking if db:seed is needed..." is_first = first_deployment?(service_name, env) if is_first puts " ✅ First deployment — running db:seed" print " 🌱 Running db:seed..." seed_cmd = "railway run --service #{shell_escape(service_name)} bundle exec rails db:seed" out, _err, _status = Open3.capture3(env, seed_cmd) puts " ✅" puts out unless out.strip.empty? else puts " ✅ Update deployment — skipping db:seed" end puts "✅ Step 6 complete" { success: true } end |
#step7_finish(deployment_url, project_id, deploy_task_id, deploy_service_id, api_client, started_at: nil) ⇒ Object
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 1040 def step7_finish(deployment_url, project_id, deploy_task_id, deploy_service_id, api_client, started_at: nil) puts "\n[Step 7] Finalising deployment..." app_url = deployment_url ? deployment_url.sub(/\Ahttps?:\/\//, "") : nil app_url = "https://#{app_url}" if app_url && !app_url.start_with?("https://") dash_url = "#{@dashboard_base_url}/#{project_id}" # Detect app port from project config — only sent on success notify app_port = detect_app_port puts " 🔌 Detected app port: #{app_port}" # Notify success immediately — don't block on health check api_client.notify( project_id: project_id, deploy_task_id: deploy_task_id, deploy_service_id: deploy_service_id, status: "success", target_port: app_port ) # Calculate total elapsed time total_seconds = started_at ? (Time.now - started_at).round : nil duration_str = total_seconds ? format_duration(total_seconds) : nil # Print success banner right away so user sees the URL without waiting puts "\n" + "=" * 60 puts "✅ DEPLOYMENT SUCCESSFUL" puts "=" * 60 puts "🌐 URL : #{app_url || "(not available)"}" puts "📊 Dashboard : #{dash_url}" puts "⏱️ Total time : #{duration_str || "n/a"}" puts "=" * 60 # Health check runs after banner — non-fatal, purely informational if app_url puts "\n🏥 Running health check (non-blocking)..." health_passed = false 3.times do |i| result = DeployTools::CheckHealth.execute(url: app_url, timeout: 30) if result[:success] puts "✅ App is live! Health check passed (HTTP #{result[:status_code]})" health_passed = true break else puts " ⚠️ Health check #{i + 1}/3: #{result[:error]}" sleep 10 unless i == 2 end end puts " ℹ️ App may still be warming up — visit the URL in a moment." unless health_passed end puts "" { success: true, url: app_url || "(not available)", dashboard_url: dash_url } end |
#timed_gets(seconds) ⇒ Object
Read a line from stdin with a timeout. Returns nil (treated as empty) if the timeout fires or stdin is not a TTY. Uses IO.select so it works on both MRI and JRuby without spawning an extra thread.
606 607 608 609 610 611 612 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 606 def timed_gets(seconds) ready = IO.select([$stdin], nil, nil, seconds) return nil unless ready $stdin.gets rescue nil end |
#write_binding_file(project_id, project_name) ⇒ Object
408 409 410 411 412 413 414 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 408 def write_binding_file(project_id, project_name) FileUtils.mkdir_p(".clacky") File.write(".clacky/openclacky.yml", <<~YAML) project_id: #{project_id} project_name: #{project_name} YAML end |
#write_categorized_config(categorized_config) ⇒ Object
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 450 def write_categorized_config(categorized_config) return if categorized_config.nil? || categorized_config.empty? # Flatten all categories into a single env hash env_vars = {} categorized_config.each_value do |vars| next unless vars.is_a?(Hash) vars.each { |k, v| env_vars[k.to_s] = v.to_s } end return if env_vars.empty? # Append to .env.development.local env_file = ".env.development.local" File.open(env_file, "a") do |f| f.puts "\n# Clacky platform integrations (auto-generated)" env_vars.each { |k, v| f.puts "#{k}=#{v}" } end # Append to config/application.yml if it exists app_yml = "config/application.yml" if File.exist?(app_yml) File.open(app_yml, "a") do |f| f.puts "\n # Clacky platform integrations (auto-generated)" env_vars.each { |k, v| f.puts " #{k}: \"#{v}\"" } end end end |
#write_deploy_task_id(deploy_task_id) ⇒ Object
Persist the most recent deploy_task_id into .clacky/openclacky.yml. Merges into the existing file so project_id / project_name are preserved.
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/clacky/default_skills/deploy/scripts/rails_deploy.rb', line 418 def write_deploy_task_id(deploy_task_id) return if deploy_task_id.to_s.strip.empty? binding_file = ".clacky/openclacky.yml" data = if File.exist?(binding_file) YAML.safe_load(File.read(binding_file)) || {} else {} end data["deploy_task_id"] = deploy_task_id.to_s.strip FileUtils.mkdir_p(".clacky") File.write(binding_file, data.to_yaml) rescue => e warn " ⚠️ Could not write deploy_task_id to #{binding_file}: #{e.}" end |