Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/connectai-e/gitmaya
🌊 One repo = one chat, make git flow in chat, next generation gitops for boosting developer-teams productivity, supports feishu, discord and slack
https://github.com/connectai-e/gitmaya
chatops discord feishu git gitmaya lark slack
Last synced: 5 days ago
JSON representation
🌊 One repo = one chat, make git flow in chat, next generation gitops for boosting developer-teams productivity, supports feishu, discord and slack
- Host: GitHub
- URL: https://github.com/connectai-e/gitmaya
- Owner: ConnectAI-E
- License: mit
- Created: 2023-12-22T02:43:21.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T15:51:44.000Z (about 2 months ago)
- Last Synced: 2024-09-15T17:08:46.160Z (about 2 months ago)
- Topics: chatops, discord, feishu, git, gitmaya, lark, slack
- Language: Python
- Homepage: https://gitmaya.com
- Size: 905 KB
- Stars: 139
- Watchers: 6
- Forks: 11
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
一款开源的、高性能的 GitOps one chat = one repo
支持飞书、discord、slack 等 (完全开源)
[![][github-logo-shield]][github-logo-link]
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[**简体中文**](./README.md) · [**English**](./README_en.md)
https://github.com/ConnectAI-E/GitMaya/assets/50035229/490b87d3-47f7-4a89-a4c7-737df359d67d
## 👋 GitMaya 的来历
生活就该简单点，开源协作也得这么干。咱们就抓重点，聊天和代码托管，这俩是核心。所以，搞个进度管理工具，就围绕这俩转。
记住了，GitMaya 就像一辆忠实的吉普车，虽然不亮眼，但能带你去任何你想去的地方。
简洁至上，实用为王。
## 🔥 功能列表
🔄 **One Repo = One Chat** 在一个聊天群中管理项目所有进展（：现在也支持关联多个仓库
🚀 **Issue 处理集成** 不出群聊，接管所有 Issue 操作
🔄 **Pr 处理集成** 从 code-diff 到 merge pr，加速代码审核
🛠 **CI/CD 和 GitHub Actions 处理集成** 对话中便捷获取最新 Github Action 进展
💬 **简化 GitHub 消息互动** 在聊天工具管理所有 GitHub 互动，不再需要切换上下文。
🌐 **跨平台支持** 聊天平台支持 飞书, Discord, Slack, Microsoft Teams, 和 TG。代码托管支持 Github 和 GitLab
## 📃 部署流程
建议使用在线版本： 🖥 立即尝试 GitMaya
如果你想手动部署 GitMaya ，需要共计 3 个步骤。
### 步骤 1. 安装 GitHub 应用
您首先需要创建一个 GitHub 应用，详细信息请参考 [从零开始部署 GitHub 应用][Deploy GitHub App From Scratch]。
### 步骤 2. 部署 GitMaya
您可以选择使用 [自托管](#self-hosting) 或 [本地部署](#local-development) 来部署 GitMaya 的前端和后端。
🛳 自托管
GitMaya 提供支持无服务器和 [Docker 镜像][docker-release-link] 的自托管版本。这使您能够在几分钟内部署自己的聊天机器人，无需任何先前的知识。
#### `A` 使用 Docker-Compose 部署
[![][docker-release-shield]][docker-release-link]
[![][docker-size-shield]][docker-size-link]
[![][docker-pulls-shield]][docker-pulls-link]
我们提供了一个 Docker 镜像，用于在您自己的私人设备上部署 GitMaya 服务。使用以下命令启动 GitMaya 服务：
###### 1. 下载 `docker-compose.yml` 和 `.env` 文件
首先，下载 `docker-compose.yml` 和 `.env` 文件；它们包含 GitMaya 服务的配置，包括 MySQL、Celery 和 Redis。
```fish
$ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/docker-compose.yml
$ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/.env.example -O .env
```
###### 2. 配置环境变量
接下来，您需要配置 `.env` 文件。您应该用您在 [步骤 1](#步骤-1-安装-github-应用) 中创建的 GitHub App 信息替换这些变量。
```fish
$ vim .env
```
**将 `GITHUB_APP_NAME`、`GITHUB_APP_ID`、`GITHUB_APP_PRIVATE_KEY`、`GITHUB_CLIENT_ID`、`GITHUB_CLIENT_SECRET`、`GITHUB_WEBHOOK_SECRET` 替换到 .env 文件中**
```fish
SECRET_KEY=""
FLASK_PERMANENT_SESSION_LIFETIME=86400*30
FLASK_SQLALCHEMY_DATABASE_URI="mysql+pymysql://root:gitmaya2023@mysql:3306/gitmaya?charset=utf8mb4&binary_prefix=true"
GITHUB_APP_NAME=your-deploy-name
GITHUB_APP_ID=114514
GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
-----END RSA PRIVATE KEY-----"
GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret
GITHUB_WEBHOOK_SECRET=secret
DOMAIN=127.0.0.1
```
> **NOTE**: **文件支持多行字符串，因此.pem 文件可以直接粘贴到 `.env` 文件中**
###### 3. 运行镜像
第一次运行时，它将初始化数据库，因此日志中可能包含一些错误消息。
```fish
$ docker-compose up -d
```
#### `B` 使用 Zeabur 或 Sealos 部署（即将推出！）
我们即将支持 Zeabur 的一键部署。
| Deploy with Zeabur |
| :---------------------------------------------------------: |
| [![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link] |
[![][back-to-top]](#readme-top)
⌨️ 本地部署
将仓库克隆到本地进行开发
#### 1. 克隆仓库
将仓库克隆到您的本地机器或服务器：
```fish
$ git clone https://github.com/ConnectAI-E/GitMaya.git
$ cd GitMaya
```
#### 2. 安装依赖
##### 使用 pip
如果您使用 `pip`
```fish
$ pip install -r requirements.txt
```
##### 使用 pdm（推荐）
如果您使用 `pdm`
```fish
$ pdm install
```
激活虚拟环境：
```fish
$ eval $(pdm venv activate)
```
#### 3. 配置文件
在开始之前，请确保您具备以下配置文件：
- `.env`: **配置飞书、GitHub 和各种中间件变量。我们提供了一个 [.env.example](https://github.com/ConnectAI-E/GitMaya/blob/main/deploy/.env.example) 作为参考**
通过替换相关变量配置数据库
```fish
# 数据库设置
FLASK_SQLALCHEMY_DATABASE_URI="mysql+pymysql://root:gitmaya2023@mysql:3306/gitmaya?charset=utf8mb4&binary_prefix=true"
```
配置 Celery，使用 Redis 作为 Broker
```fish
# Celery 设置
CELERY_BROKER_URL=redis://redis:6379/1
CELERY_RESULT_BACKEND=redis://redis:6379/2
```
配置 GitHub App，详细信息请参考: [从零开始部署 GitHub App][Deploy GitHub App From Scratch]
```fish
# GitHub 设置
GITHUB_APP_NAME=test
GITHUB_APP_ID=1024
GITHUB_CLIENT_ID=test
GITHUB_CLIENT_SECRET=test
GITHUB_WEBHOOK_SECRET=secret
GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
-----END RSA PRIVATE KEY-----"
```
配置服务器地址
```fish
DOMAIN=127.0.0.1
```
（可选）配置 Flask
```fish
# Flask 设置
SECRET_KEY="test"
FLASK_PERMANENT_SESSION_LIFETIME=86400
```
#### 4. 运行服务器
启动 Redis：
```fish
$ docker run -d -p 6379:6379 redis:alpine
```
启动 Celery，使用 Redis 作为 Broker：
```fish
$ cd server
$ celery -A tasks.celery worker -l INFO -c 2
```
启动 MySQL：
```fish
$ docker run --name mysql -e MYSQL_ROOT_PASSWORD=gitmaya2023 -e MYSQL_DATABASE=gitmaya -e TZ=Asia/Shanghai -p 3306:3306 -v /path/to/your/mysql/data:/var/lib/mysql -v /path/to/your/mysql/conf.d:/etc/mysql/conf.d -d mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION
```
创建数据库和表 （仅需要一次）：
```fish
$ flask --app server/server:app create
```
使用 `gunicorn` 运行 GitMaya 服务器：
```fish
$ gunicorn --worker-class=gevent --workers 1 --bind 0.0.0.0:8888 -t 600 --keep-alive 60 --log-level=info server:app
```
### 步骤 3. 部署飞书 App 机器人
部署飞书（Lark）机器人应用的步骤已经集成到 GitMaya 的入门流程中。完成入门流程将自动完成与飞书相关的配置。更多详细信息，请参考 [从零开始部署飞书 App 机器人][Deploy Feishu App Bot From Scratch]。
## 📕 参考
- [从零开始部署飞书 App 机器人][Deploy Feishu App Bot From Scratch]
- [从零开始部署 GitHub App][Deploy GitHub App From Scratch]
- [飞书 App 官方文档][Feishu App Official Doc]
- [GitHub App 官方文档][GitHub App Official Doc]
[![][back-to-top]](#readme-top)
## 📦 生态系统
GitMaya 系列有多个仓库，这是其中之一：
| | 仓库 | 语言 | 用途 |
| --- | --------------------------------------------------------- | ------ | ----------------- |
| 👉 | [GitMaya](https://github.com/ConnectAI-E/GitMaya) | Python | 服务器端代码 |
| | [GitMaya-Cli](https://github.com/ConnectAI-E/GitMaya-Cli) | Python | 超级 Git 管理工具 |
[![][back-to-top]](#readme-top)
## 🤝 立即参与贡献
Gitmaya 是完全开源的，由开发者们共同打造。请随时通过代码将你想要的功能变为现实。
[![][pr-welcome-shield]][pr-welcome-link]
[![][back-to-top]](#readme-top)
## 👻 替代方案
GitMaya` 受到以下工具的启发。
- [pullpo](https://pullpo.io/)
- [graphite](https://graphite.dev/)
- [typoapp](https://typoapp.io/)
它们都很棒，但关注的重点和功能集合不同，有兴趣也可以试试 :)
📝 License
[![][fossa-license-shield]][fossa-license-link]
Copyright © 2024 [ConnectAI-E][profile-link].
This project is [MIT](./LICENSE) licensed.
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[fossa-license-link]: [https://app.fossa.com/projects/git%2Bgithub.com%2Fconnectai-e%2Fgitmaya](https://app.fossa.com/projects/git%2Bgithub.com%2FConnectAI-E%2FGitMaya?ref=badge_large)
[fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FConnectAI-E%2FGitMaya.svg?type=large
[profile-link]: https://github.com/connectai-e
[pr-welcome-link]: https://github.com/connectai-e/gitmaya/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[codespaces-link]: https://codespaces.new/connectai-e/gitmaya
[codespaces-shield]: https://github.com/codespaces/badge.svg
[github-logo-shield]: https://img.shields.io/badge/gitmaya-enabled?style=flat-square&logo=github&color=F9DC4E&logoColor=D9E0EE&labelColor=302D41
[github-logo-link]: https://github.com/connectai-e/gitmaya
[github-contributors-link]: https://github.com/connectai-e/gitmaya/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/connectai-e/gitmaya?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/connectai-e/gitmaya/network/members
[github-forks-shield]: https://img.shields.io/github/forks/connectai-e/gitmaya?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/connectai-e/gitmaya/issues
[github-issues-shield]: https://img.shields.io/github/issues/connectai-e/gitmaya?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/connectai-e/gitmaya/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/github/license/connectai-e/gitmaya?color=white&labelColor=black&style=flat-square
[github-project-link]: https://github.com/connectai-e/gitmaya/projects
[github-release-link]: https://github.com/connectai-e/gitmaya/releases
[github-releasedate-link]: https://github.com/connectai-e/gitmaya/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/connectai-e/gitmaya?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/connectai-e/gitmaya/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/connectai-e/gitmaya?color=ffcb47&labelColor=black&style=flat-square
[docker-pulls-link]: https://hub.docker.com/r/connectai/gitmaya
[docker-pulls-shield]: https://img.shields.io/docker/pulls/connectai/gitmaya?color=45cc11&labelColor=black&style=flat-square
[docker-release-link]: https://hub.docker.com/r/connectai/gitmaya
[docker-release-shield]: https://img.shields.io/docker/v/connectai/gitmaya?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square
[docker-size-link]: https://hub.docker.com/r/connectai/gitmaya
[docker-size-shield]: https://img.shields.io/docker/image-size/connectai/gitmaya?color=369eff&labelColor=black&style=flat-square
[deploy-on-sealos-button-image]: https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg
[deploy-on-sealos-link]: https://cloud.sealos.io/?xxx
[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
[deploy-on-zeabur-link]: https://zeabur.com/
[Deploy GitHub App From Scratch]: https://connect-ai.feishu.cn/wiki/OnVNwqZlhi5yM4keBWAcUF3ynFf?from=from_copylink
[Deploy GitHub App From Scratch]: https://connect-ai.feishu.cn/wiki/Qwq0wmamFiFTaXk1hfocwfpNnqf?from=from_copylink
[Deploy Feishu App Bot From Scratch]: https://connect-ai.feishu.cn/wiki/NQXywcS3Siqw60kYX8IcknDfn1e?from=from_copylink
[Feishu App Official Doc]: https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/step-1-create-app-and-enable-robot-capabilities
[GitHub App Official Doc]: https://docs.github.com/en/developers/apps/creating-a-github-app
