gitlabhq/lib/wiki_to_gollum_migrator.rb
Dan Knox f0aa54e0fb Create Wiki migration task.
This commit adds a new Rake task for migrating all of your existing
Wiki content from your database into new Gollum repositories.

The bulk of the logic happens within the `WikiToGollumMigrator`
class which is decently test covered and located in the lib directory.

The new Rake task can be executed by running:

   `bundle exec rake gitlab:wiki:migrate`

It will output a nice log of every project that it migrates along
with success or failure messages.

I have used it on my own installation to migrate my Wikis successfully.
2013-03-10 19:10:44 -07:00

104 lines
2.8 KiB
Ruby

class WikiToGollumMigrator
attr_reader :projects
def initialize
@projects = []
Project.find_in_batches(batch_size: 50) do |batch|
batch.each { |p| @projects << p if p.wikis.any? }
end
end
def migrate!
projects.each do |project|
log "\nMigrating Wiki for '#{project.path_with_namespace}'"
wiki = create_gollum_repo(project)
create_pages project, wiki
log "Project '#{project.path_with_namespace}' migrated. " + "[OK]".green
end
end
private
def create_gollum_repo(project)
GollumWiki.new(project, nil).wiki
end
def create_pages(project, wiki)
pages = project.wikis.group(:slug).all
pages.each do |page|
create_page_and_revisions(project, page)
end
end
def create_page_and_revisions(project, page)
# Grab all revisions of the page
revisions = project.wikis.where(slug: page.slug).ordered.all
# Remove the first revision created from the array
# and use it to create the Gollum page. Each successive revision
# will then be applied to the new Gollum page as an update.
first_rev = revisions.pop
wiki = GollumWiki.new(project, page.user)
wiki_page = WikiPage.new(wiki)
attributes = extract_attributes_from_page(first_rev)
if wiki_page.create(attributes)
log " Created page '#{wiki_page.title}' " + "[OK]".green
# Reverse the revisions to create them in the correct
# chronological order.
create_revisions(project, wiki_page, revisions.reverse)
else
log " Failed to create page '#{wiki_page.title}' " + "[FAILED]".red
end
end
def create_revisions(project, page, revisions)
revisions.each do |revision|
log " Creating revisions..."
# Reinitialize a new GollumWiki instance for each page
# and revision created so the correct User is shown in
# the commit message.
wiki = GollumWiki.new(project, revision.user)
wiki_page = wiki.find_page(page.slug)
attributes = extract_attributes_from_page(revision)
content = attributes[:content]
if wiki_page.update(content)
log " Created revision " + "[OK]".green
else
log " Failed to create revision " + "[FAILED]".red
end
end
end
def extract_attributes_from_page(page)
attributes = page.attributes
.with_indifferent_access
.slice(:title, :content)
# Change 'index' pages to 'home' pages to match Gollum standards
if attributes[:title].downcase == "index"
attributes[:title] = "home" unless home_already_exists?(project)
end
attributes
end
def home_already_exists?(project)
project.wikis.where(title: 'home').any? || project.wikis.where(title: 'Home').any?
end
def log(message)
puts message
end
end