traefik/mixtus

Lasius Mixtus - 从其他仓库发布文档到GitHub仓库

https://github.com/traefik/mixtus/workflows/Main/badge.svg?branch=master](https://github.com/traefik/mixtus/actions)

概述和主要用途

Lasius Mixtus是一款跨CI工具（支持GitHub Actions、SemaphoreCI 1和2、TravisCI等），用于将不同项目的文档聚合到一个仓库。当需要从多个来源构建聚合文档时，该工具非常有用。它通过创建PR而非直接提交来避免冲突，并能够在合并前验证整体文档。

核心功能和特性

• 跨CI支持：兼容多种CI平台，包括GitHub Actions、SemaphoreCI、TravisCI等
• PR创建机制：通过创建PR而非直接提交文档更改，避免冲突
• 文档验证支持：允许在合并前验证整体文档的完整性和正确性
• 灵活配置：支持自定义源仓库和目标仓库路径、所有者、仓库名称等参数

使用场景

适用于需要从多个项目或来源构建聚合文档的场景，例如：

• 多个相关项目的文档需要统一存储和展示
• 需要集中管理不同版本或模块的文档
• 希望在合并文档更改前进行审核和验证

配置参数

命令行参数

工作流示例

!mixtus-workflow

该工作流还使用了以下工具：

• https://github.com/traefik/structor%EF%BC%9A%E5%88%9B%E5%BB%BAMkdocs%E6%96%87%E6%A1%A3%E7%9A%84%E5%A4%9A%E4%B8%AA%E7%89%88%E6%9C%AC
• https://github.com/traefik/mixtus%EF%BC%9A%E5%88%9B%E5%BB%BA%E5%8C%85%E5%90%AB%E6%96%87%E6%A1%A3%E6%9B%B4%E6%94%B9%E7%9A%84PR
• https://github.com/traefik/lobicornis%EF%BC%9A%E8%87%AA%E5%8A%A8%E9%87%8D%E5%AE%9A%E5%9F%BA%E5%92%8C%E5%90%88%E5%B9%B6PR

最终成果示例：[***]

使用示例

命令行示例

bash
GITHUB_TOKEN=xxx ./mixtus \
--src-owner=containous \
--src-repo-name=traefik \
--src-doc-path="./docs/site/" \
--dst-repo-name=doc \
--dst-doc-path="./traefik" \
--git-user-name=botname \
--git-user-email=bot@example.com

Docker运行示例

bash
docker run -e GITHUB_TOKEN=xxx traefik/mixtus \
--src-owner=containous \
--src-repo-name=traefik \
--src-doc-path="./docs/site/" \
--dst-repo-name=doc \
--dst-doc-path="./traefik" \
--git-user-name=botname \
--git-user-email=bot@example.com

Mymirca工具集

• https://github.com/traefik/lobicornis 🐜: 自动重定基和合并PR
• https://github.com/traefik/aloba 🐜: 为PR和问题添加标签和里程碑
• https://github.com/traefik/structor 🐜: 使用Mkdocs管理多个版本的文档
• https://github.com/traefik/mixtus 🐜: 从其他仓库发布文档到GitHub仓库
• https://github.com/traefik/bibikoffi 🐜: 关闭陈旧的问题
• https://github.com/traefik/kutteri 🐜: 跟踪GitHub仓库并在Slack上发布通知
• https://github.com/traefik/gallienii 🐜: 保持Fork仓库同步

名称含义

!Lasius Mixtus