b8af719bb7
Aliases are defined in the configuration file under the `aliases` key. The configuration is a map of alias name to command. When we run the command the we just do a literal replacement of the alias with the string. So if we have: ```yaml aliases: console: app exec -r console -i --reuse "rails console" ``` Then running `kamal console -r workers` will run the command ```sh $ kamal app exec -r console -i --reuse "rails console" -r workers ``` Because of the order Thor parses the arguments, this allows us to override the role from the alias command. There might be cases where we need to munge the command a bit more but that would involve getting into Thor command parsing internals, which are complicated and possibly subject to change. There's a chance that your aliases could conflict with future built-in commands, but there's not likely to be many of those and if it happens you'll get a validation error when you upgrade. Thanks to @dhnaranjo for the idea!
137 lines
3.1 KiB
Ruby
Executable File
137 lines
3.1 KiB
Ruby
Executable File
#!/usr/bin/env ruby
|
|
require "stringio"
|
|
|
|
def usage
|
|
puts "Usage: #{$0} <kamal_site_repo>"
|
|
exit 1
|
|
end
|
|
|
|
usage if ARGV.size != 1
|
|
|
|
kamal_site_repo = ARGV[0]
|
|
|
|
if !File.directory?(kamal_site_repo)
|
|
puts "Error: #{kamal_site_repo} is not a directory"
|
|
exit 1
|
|
end
|
|
|
|
DOCS = {
|
|
"accessory" => "Accessories",
|
|
"alias" => "Aliases",
|
|
"boot" => "Booting",
|
|
"builder" => "Builders",
|
|
"configuration" => "Configuration overview",
|
|
"env" => "Environment variables",
|
|
"healthcheck" => "Healthchecks",
|
|
"logging" => "Logging",
|
|
"registry" => "Docker Registry",
|
|
"role" => "Roles",
|
|
"servers" => "Servers",
|
|
"ssh" => "SSH",
|
|
"sshkit" => "SSHKit",
|
|
"traefik" => "Traefik"
|
|
}
|
|
|
|
class DocWriter
|
|
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
|
|
|
def initialize(from_file, to_dir)
|
|
@from_file = from_file
|
|
@key = File.basename(from_file, ".yml")
|
|
@to_file = File.join(to_dir, "#{linkify(DOCS[key])}.md")
|
|
@body = File.readlines(from_file)
|
|
@heading = body.shift.chomp("\n")
|
|
@output = nil
|
|
end
|
|
|
|
def write
|
|
puts "Writing #{to_file}"
|
|
generate_markdown
|
|
File.write(to_file, output.string)
|
|
end
|
|
|
|
private
|
|
def generate_markdown
|
|
@output = StringIO.new
|
|
|
|
generate_header
|
|
|
|
place = :in_section
|
|
|
|
loop do
|
|
line = body.shift&.chomp("\n")
|
|
break if line.nil?
|
|
|
|
case place
|
|
when :new_section, :in_section
|
|
if line.empty?
|
|
output.puts
|
|
place = :new_section
|
|
elsif line =~ /^ *#/
|
|
generate_line(line, heading: place == :new_section)
|
|
place = :in_section
|
|
else
|
|
output.puts "```yaml"
|
|
output.puts line
|
|
place = :in_yaml
|
|
end
|
|
when :in_yaml, :in_empty_line_yaml
|
|
if line =~ /^ *#/
|
|
output.puts "```"
|
|
generate_line(line, heading: place == :in_empty_line_yaml)
|
|
place = :in_section
|
|
elsif line.empty?
|
|
place = :in_empty_line_yaml
|
|
else
|
|
output.puts line
|
|
end
|
|
end
|
|
end
|
|
|
|
output.puts "```" if place == :in_yaml
|
|
end
|
|
|
|
def generate_header
|
|
output.puts "---"
|
|
output.puts "title: #{heading[2..-1]}"
|
|
output.puts "---"
|
|
output.puts
|
|
output.puts heading
|
|
output.puts
|
|
end
|
|
|
|
def generate_line(line, heading: false)
|
|
line = line.gsub(/^ *#\s?/, "")
|
|
|
|
if line =~ /(.*)kamal docs ([a-z]*)(.*)/
|
|
line = "#{$1}[#{DOCS[$2]}](../#{linkify(DOCS[$2])})#{$3}"
|
|
end
|
|
|
|
if line =~ /(.*)https:\/\/kamal-deploy.org([a-z\/-]*)(.*)/
|
|
line = "#{$1}[#{titlify($2.split("/").last)}](#{$2})#{$3}"
|
|
end
|
|
|
|
if heading
|
|
output.puts "## [#{line}](##{linkify(line)})"
|
|
else
|
|
output.puts line
|
|
end
|
|
end
|
|
|
|
def linkify(text)
|
|
text.downcase.gsub(" ", "-")
|
|
end
|
|
|
|
def titlify(text)
|
|
text.capitalize.gsub("-", " ")
|
|
end
|
|
end
|
|
|
|
from_dir = File.join(File.dirname(__FILE__), "../lib/kamal/configuration/docs")
|
|
to_dir = File.join(kamal_site_repo, "docs/configuration")
|
|
Dir.glob("#{from_dir}/*") do |from_file|
|
|
key = File.basename(from_file, ".yml")
|
|
|
|
DocWriter.new(from_file, to_dir).write
|
|
end
|