traefik/mixtus Docker Image Overview

traefik/mixtus

traefik

Lasius Mixtus是一款跨CI工具（GitHub Actions、SemaphoreCI、TravisCI等），用于将不同项目的文档聚合到一个仓库，通过创建PR而非直接提交来避免冲突，支持合并前验证整体文档。

下载次数: 0状态：社区镜像维护者：traefik仓库类型：镜像最近更新：5 年前

轩辕镜像，让镜像更快，让人生更轻。点击查看

中文简介版本下载

轩辕镜像，让镜像更快，让人生更轻。点击查看

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

![GitHub release]([] ![Build Status]([] ![Docker Build Status]([***]

概述和主要用途

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

核心功能和特性

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

使用场景

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

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

配置参数

命令行参数

参数名	描述	默认值	环境变量
`-debug`	启用调试模式	-	-
`-dst-doc-path`	目标文档存放路径	`"./traefik"`	-
`-dst-owner`	目标文档仓库的所有者	`"traefik"`	-
`-dst-repo-name`	目标文档仓库的名称	`"doc"`	-
`-git-user-email`	提交文档时使用的***	-	`GIT_USER_EMAIL`
`-git-user-name`	提交文档时使用的用户名	-	`GIT_USER_NAME`
`-h`	显示帮助信息	-	-
`-src-doc-path`	源文档路径	`"./docs/site"`	-
`-src-owner`	源仓库的所有者	`"traefik"`	-
`-src-repo-name`	源仓库的名称	`"traefik"`	-
`-token`	GitHub令牌	-	`GITHUB_TOKEN`

工作流示例

!mixtus-workflow

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

structor：创建Mkdocs文档的多个版本
mixtus：创建包含文档更改的PR
lobicornis：自动重定基和合并PR

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

使用示例

命令行示例

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=***

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=***