2020-10-23 11:59:45 -04:00
|
|
|
---
|
|
|
|
|
date: "2019-04-15T17:29:00+08:00"
|
|
|
|
|
title: "Migrations Interfaces"
|
|
|
|
|
slug: "migrations-interfaces"
|
2023-07-26 00:53:13 -04:00
|
|
|
sidebar_position: 55
|
2020-12-09 01:47:06 -05:00
|
|
|
toc: false
|
2020-10-23 11:59:45 -04:00
|
|
|
draft: false
|
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-27 23:33:41 -04:00
|
|
|
aliases:
|
|
|
|
|
- /en-us/migrations-interfaces
|
2020-10-23 11:59:45 -04:00
|
|
|
menu:
|
|
|
|
|
sidebar:
|
2023-03-23 11:18:24 -04:00
|
|
|
parent: "development"
|
2020-10-23 11:59:45 -04:00
|
|
|
name: "Migrations Interfaces"
|
2023-07-26 00:53:13 -04:00
|
|
|
sidebar_position: 55
|
2020-10-23 11:59:45 -04:00
|
|
|
identifier: "migrations-interfaces"
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Migration Features
|
|
|
|
|
|
|
|
|
|
Complete migrations were introduced in Gitea 1.9.0. It defines two interfaces to support migrating
|
2022-07-27 21:22:47 -04:00
|
|
|
repository data from other Git host platforms to Gitea or, in the future, migrating Gitea data to other Git host platforms.
|
|
|
|
|
|
2021-12-23 22:56:57 -05:00
|
|
|
Currently, migrations from GitHub, GitLab, and other Gitea instances are implemented.
|
2020-10-23 11:59:45 -04:00
|
|
|
|
2022-07-27 21:22:47 -04: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 11:59:45 -04:00
|
|
|
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`.
|
|
|
|
|
|
|
|
|
|
## Downloader Interfaces
|
|
|
|
|
|
2021-12-23 22:56:57 -05:00
|
|
|
To migrate from a new Git host platform, there are two steps to be updated.
|
2020-10-23 11:59:45 -04:00
|
|
|
|
|
|
|
|
- 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`.
|
2022-07-27 21:22:47 -04:00
|
|
|
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on `init()`.
|
2020-10-23 11:59:45 -04:00
|
|
|
|
2021-11-17 02:17:37 -05:00
|
|
|
You can find these interfaces in [downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go).
|
2020-10-23 11:59:45 -04: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 02:17:37 -05:00
|
|
|
You can find these interfaces in [uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go).
|
