2020-10-23 23:59:45 +08:00
|
|
|
---
|
|
|
|
date: "2019-04-15T17:29:00+08:00"
|
|
|
|
title: "Migrations Interfaces"
|
|
|
|
slug: "migrations-interfaces"
|
|
|
|
weight: 30
|
2020-12-09 14:47:06 +08:00
|
|
|
toc: false
|
2020-10-23 23:59:45 +08:00
|
|
|
draft: false
|
|
|
|
menu:
|
|
|
|
sidebar:
|
|
|
|
parent: "developers"
|
|
|
|
name: "Migrations Interfaces"
|
|
|
|
weight: 55
|
|
|
|
identifier: "migrations-interfaces"
|
|
|
|
---
|
|
|
|
|
|
|
|
# Migration Features
|
|
|
|
|
|
|
|
Complete migrations were introduced in Gitea 1.9.0. It defines two interfaces to support migrating
|
|
|
|
repository data from other git host platforms to Gitea or, in the future, migrating Gitea data to other
|
|
|
|
git host platforms.
|
|
|
|
Currently, migrations from Github, Gitlab, and other Gitea instances are implemented.
|
|
|
|
|
2021-11-17 15:17:37 +08:00
|
|
|
First of all, Gitea defines some standard objects in packages [modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration).
|
2020-10-23 23:59:45 +08:00
|
|
|
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`.
|
|
|
|
|
|
|
|
## Downloader Interfaces
|
|
|
|
|
|
|
|
To migrate from a new git host platform, there are two steps to be updated.
|
|
|
|
|
|
|
|
- You should implement a `Downloader` which will be used to get repository information.
|
|
|
|
- You should implement a `DownloaderFactory` which will be used to detect if the URL matches and create the above `Downloader`.
|
|
|
|
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on `init()`.
|
|
|
|
|
2021-11-17 15:17:37 +08:00
|
|
|
You can find these interfaces in [downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go).
|
2020-10-23 23:59:45 +08:00
|
|
|
|
|
|
|
## Uploader Interface
|
|
|
|
|
|
|
|
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded
|
|
|
|
data via this `Uploader` to the local Gitea instance. Other uploaders are not supported at this time.
|
|
|
|
|
2021-11-17 15:17:37 +08:00
|
|
|
You can find these interfaces in [uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go).
|