Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schrepfler/gitlab-migrator
GitLab Migrator is a java application which can be used to migrate GitLab groups into an GitHub organisation and keep locally checkout out groups in sync with upstream.
https://github.com/schrepfler/gitlab-migrator
gitlab gitlab-migrated gitlabmigration
Last synced: about 1 month ago
JSON representation
GitLab Migrator is a java application which can be used to migrate GitLab groups into an GitHub organisation and keep locally checkout out groups in sync with upstream.
- Host: GitHub
- URL: https://github.com/schrepfler/gitlab-migrator
- Owner: schrepfler
- License: apache-2.0
- Created: 2022-09-27T14:04:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T01:25:05.000Z (about 1 year ago)
- Last Synced: 2024-10-13T15:49:26.730Z (2 months ago)
- Topics: gitlab, gitlab-migrated, gitlabmigration
- Language: Java
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# GitLab Migrator
GitLab Migrator is a Java application which can be used primarily to map and migrate GitLab groups into a GitHub organisation.
You can also use it to keep GitLab repositories synced up locally and eventuall it'll be able to keep your GitLab and GitHub in sync.
### TODO badges
## Installation
TODO Needs implementing CI/CD for binaries and publish.
```bash
...
```
## Usage
Gitlab Migrator consists of the following commands
### Init
This command will fetch the GitLab group, subgroups and repository information locally, will scan the GitHub organisation and then save this information.
```shell
gitlab-migrator init --group-id-or-path=
--gitlab-access-token=
--github-organization=
--github-personal-access-token=
[--migrator-db-file=]
```
### Export
This command will clone the gitlab repositories locally.
```shell
gitlab-migrator export --target-directory=
--group-id-or-path=
--gitlab-access-token=
--expanded=
--enable-gitlab-logging=
```
### WIP Map Organisation
### WIP Migrate
```shell
gitlab-migrator migrate --github-organization=
--github-personal-access-token=
--gitlab-personal-access-token=
--group-id-or-path=
[--mapping-file=]
[--target-directory=]
[--delete-organization-projects]
```
When executing the tool you'll go through two phases.
- In the first go, the tool will create a file (default value `repo-mappings.json`)
which will be populated with a map of all repositories in the origin GitLab group at which point it will stop.
You can now modify that map and customise the title of the target repository as GitHub does not have support for groups
and sub-groups so this is a good moment to establish a naming convention.
- In the second run, the tool should start cloning locally the repositories in the `target-directory` location and once
finished it should start creating repositories in the target GitHub organisation and pushing the local repos
(including branches and tags) into them.
- In case of errors during processing the `mirrorStatus` will move from `TODO` to `ERROR` or in case of hitting the
GitHub API rate limit `RATE_LIMIT_HIT_DELAYED`. Once you understand the error or the rate limit has expired you can
move the `mirrorStatus` back in `TODO` and the application will retry the repositories which are in `TODO` state.
In that case it will skip the `PUSHED` or errored repositories and will also refresh the list in the case there are
newly added repositories in the GitLab group.
- There's a nuclear option to nuke all GitHub organisation repositories if for some reason you want to refresh the
repositories as we don't support sync between remotes. Contributions are welcome. Use at own responsibility!
```json
{
"repoMappings" : {
"123456788" : {
"id" : 123456788,
"origin" : "top-group/sub-group/fancy-app",
"title" : "TOPGROUP SUBGROUP fancy-app",
"mirrorStatus" : "TODO"
},
"123456789" : {
"id": 123456789,
...
}
...
```
## Build
Creating the release files locally can be performed using
```shell
mvn clean install jreleaser:assemble
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[Apache-2.0](https://spdx.org/licenses/Apache-2.0.html)
## Roadmap
- Add and Validate support for hosted GitLab CE
- Track upstream repos and push updates.
- Handle adding users to organisation.
- Handle existing target repo.
- Not sure if description is migrated?
- Support multiple commands.
- Make it more robust.