discourse/migrations/bin/cli
Gerhard Schlager 58558849ac
DEV: Add options to run only or skip some steps in converter and importer (#35127)
Examples:

* Run only the "badges" and "users" steps in the converter:
  ```
  migrations/bin/cli convert discourse --reset --only=badges,users
  ```

* Run all steps except "users" in the converter:
  ```
  migrations/bin/cli convert discourse --reset --skip=users
  ```

* Run only the "badges" step in importer:
   This also runs all steps that "badges" depends on (e.g. "users" and "uploads").
  ```
  migrations/bin/cli import --reset --only=badges
  ```

* Run only the "badges" step in importer and skip the "users" on which "badges" depends:
  ```
  migrations/bin/cli import --reset --only=badges --skip=users
  ```
2025-10-03 16:44:36 +02:00

92 lines
2.8 KiB
Ruby
Executable file

#!/usr/bin/env ruby
# frozen_string_literal: true
require_relative "../migrations"
require "colored2"
require "thor"
module Migrations
configure_zeitwerk
enable_i18n
module CLI
class Application < Thor
desc "convert [FROM]", "Convert a file"
option :settings, type: :string, desc: "Path of settings file", banner: "path"
option :reset, type: :boolean, desc: "Reset database before converting data"
option :only,
type: :string,
desc: "Run only specified steps (comma-separated)",
banner: "step1,step2"
option :skip,
type: :string,
desc: "Skip specified steps (comma-separated)",
banner: "step1,step2"
def convert(converter_type)
modified_options = modify_step_options
::Migrations::CLI::ConvertCommand.new(converter_type, modified_options).execute
end
desc "import", "Import a file"
option :reset, type: :boolean, desc: "Reset MappingsDB before importing data"
option :only,
type: :string,
desc: "Run only specified steps (comma-separated)",
banner: "step1,step2"
option :skip,
type: :string,
desc: "Skip specified steps (comma-separated)",
banner: "step1,step2"
def import
modified_options = modify_step_options
::Migrations::CLI::ImportCommand.new(modified_options).execute
end
desc "upload", "Upload media uploads"
option :settings,
type: :string,
desc: "Uploads settings file path",
default: "./migrations/config/upload.yml",
aliases: "-s",
banner: "path"
option :fix_missing, type: :boolean, desc: "Fix missing uploads"
option :optimize, type: :boolean, desc: "Optimize uploads"
def upload
::Migrations::CLI::UploadCommand.new(options).execute
end
desc "schema [COMMAND]", "Manage database schema"
subcommand "schema", ::Migrations::CLI::SchemaSubCommand
def self.exit_on_failure?
true
end
private
def modify_step_options
modified_options = options.dup
modified_options[:only] = split_step_class_names(options[:only])
modified_options[:skip] = split_step_class_names(options[:skip])
modified_options
end
def split_step_class_names(class_names)
class_names.presence&.split(",")&.map { |name| name.strip.demodulize.underscore } || []
end
end
end
end
if defined?(RubyVM::YJIT)
RubyVM::YJIT.enable
else
warn "WARNING: Performance degraded: RubyVM::YJIT is not available".yellow
end
# rubocop:disable Discourse/NoChdir
Dir.chdir(File.expand_path("../..", __dir__)) do
::Migrations::CLI::ExceptionHandler.handle_and_exit { ::Migrations::CLI::Application.start }
end
# rubocop:enable Discourse/NoChdir