Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/furmanp/gitlab-activity-importer
Automatically recreate your GitLab activity chart in Github without moving entire codebase.
https://github.com/furmanp/gitlab-activity-importer
git github gitlab
Last synced: 13 days ago
JSON representation
Automatically recreate your GitLab activity chart in Github without moving entire codebase.
- Host: GitHub
- URL: https://github.com/furmanp/gitlab-activity-importer
- Owner: furmanp
- License: mit
- Created: 2024-10-13T19:33:47.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-24T16:17:26.000Z (29 days ago)
- Last Synced: 2024-11-24T16:22:06.462Z (29 days ago)
- Topics: git, github, gitlab
- Language: Go
- Homepage:
- Size: 12.4 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/furmanp/gitlab-activity-importer)
# Git activity Importer (Gitlab -> Github)
A tool to transfer your GitLab commit history to GitHub, reflecting your GitLab activity on GitHub’s contribution graph.
# Table of Contents
- [Git activity Importer (Gitlab -\> Github)](#git-activity-importer-gitlab---github)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Features](#features)
- [Setup](#setup)
- [1. Automatic Imports (Recommended)](#1-automatic-imports-recommended)
- [2. Manual Imports](#2-manual-imports)
- [Configuration](#configuration)
- [Important Notes:](#important-notes)
- [License](#license)
## Overview
This tool fetches your commit history from private GitLab repositories and imports it into a specified GitHub repository, creating a visual representation of your activity on GitHub’s contribution graph. It can be configured for automated daily imports or manual runs.
## Features
- Automated Daily Imports: Syncs your GitLab activity with GitHub automatically each day.
- Manual Imports: Allows on-demand updates.
- Secure Data Handling: Requires minimal permissions and uses GitHub repository secrets for configuration.
## Setup
### 1. Automatic Imports (Recommended)
This approach will automatically keep your activity up to date. The program is being run daily at midnight UTC.
It imports your latest commits and automatically pushes them to specified GitHub repository.
To do that follow these steps:
1. **Fork this repository** to your GitHub account.
2. **Create an empty repository** in your GitHub profile where the commits will be pushed.
3. **Configure repository secrets** in your forked repository:
- Go to your forked repository settings.
- Under **Security**, navigate to **Secrets and variables > Actions**.
- Add the following secrets:
| Secret Name | Description |
| ----------------- | ---------------------------------------------------------------------- |
| `BASE_URL` | URL of your GitLab instance (e.g., `https://gitlab.com`) |
| `COMMITER_EMAIL` | Email associated with your GitHub profile |
| `COMMITER_NAME` | Your full name as it appears on GitHub |
| `GITLAB_TOKEN` | GitLab personal access token (read permissions only) |
| `ORIGIN_TOKEN` | GitHub personal access token (with write permissions for auto-push) |
| `ORIGIN_REPO_URL` | HTTPS URL of your GitHub repository (ensure it has a `.git` extension) |
Once these variables are saved in your Repository secrets, your commits will be automatically updated every day.
### 2. Manual Imports
If you prefer to run the importer manually:
1. **Download the latest release** of the tool.
2. Set up the same environment variables on your local machine:
```
export BASE_URL=https://gitlab.com
export [email protected]
...
```
3. Run the tool locally whenever you want to sync your activity.
## Configuration
This project uses GitHub Actions to automate builds and daily synchronization:
- GitHub Actions Workflow: The .github/workflows/schedule.yml defines the automation steps for building and running the tool.
- Secrets Configuration: The secrets allow secure storage and retrieval of required tokens and URLs during automation.
### Important Notes:
- **GitLab permissions:** The tool only requires read access to your GitLab repositories.
- **GitHub permissions:** Your GitHub token must have write access to the destination repository for automatic pushes.
## License
This project is licensed under the MIT License, which allows for free, unrestricted use, copying, modification, and distribution with attribution.